This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Bump version for 5.21.12 (although it's unlikely to happen)
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
7f9fef93
SH
5[ this is a template for a new perldelta file. Any text flagged as XXX needs
6to be processed before release. ]
7
8perldelta - what is new for perl v5.21.12
c68523cb 9
238894db 10=head1 DESCRIPTION
c68523cb 11
7f9fef93 12This document describes differences between the 5.21.11 release and the 5.21.12
238894db 13release.
c68523cb 14
7f9fef93
SH
15If you are upgrading from an earlier release such as 5.21.10, first read
16L<perl52111delta>, which describes differences between 5.21.10 and 5.21.11.
2ec11c70 17
7f9fef93 18=head1 Notice
b9c683b3 19
7f9fef93 20XXX Any important notices here
2e4abf26 21
7f9fef93 22=head1 Core Enhancements
2e4abf26 23
7f9fef93
SH
24XXX New core language features go here. Summarize user-visible core language
25enhancements. Particularly prominent performance optimisations could go
26here, but most should go in the L</Performance Enhancements> section.
fea59588 27
7f9fef93 28[ List each enhancement as a =head2 entry ]
83a5d6b6 29
7f9fef93 30=head1 Security
e455391f 31
7f9fef93
SH
32XXX Any security-related notices go here. In particular, any security
33vulnerabilities closed should be noted here rather than in the
34L</Selected Bug Fixes> section.
e455391f 35
7f9fef93 36[ List each security issue as a =head2 entry ]
53902397 37
7f9fef93 38=head1 Incompatible Changes
79a77127 39
7f9fef93 40XXX For a release on a stable branch, this section aspires to be:
c14a43b7 41
7f9fef93
SH
42 There are no changes intentionally incompatible with 5.XXX.XXX
43 If any exist, they are bugs, and we request that you submit a
44 report. See L</Reporting Bugs> below.
c14a43b7 45
7f9fef93 46[ List each incompatible change as a =head2 entry ]
c14a43b7 47
7f9fef93 48=head1 Deprecations
47cb8ddb 49
7f9fef93 50XXX Any deprecated features, syntax, modules etc. should be listed here.
c14a43b7 51
7f9fef93 52=head2 Module removals
c14a43b7 53
7f9fef93 54XXX Remove this section if inapplicable.
c14a43b7 55
7f9fef93
SH
56The following modules will be removed from the core distribution in a
57future release, and will at that time need to be installed from CPAN.
58Distributions on CPAN which require these modules will need to list them as
59prerequisites.
51c2f40f 60
7f9fef93
SH
61The core versions of these modules will now issue C<"deprecated">-category
62warnings to alert you to this fact. To silence these deprecation warnings,
63install the modules in question from CPAN.
51c2f40f 64
7f9fef93
SH
65Note that these are (with rare exceptions) fine modules that you are encouraged
66to continue to use. Their disinclusion from core primarily hinges on their
67necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
68not usually on concerns over their design.
83a5d6b6 69
7f9fef93 70=over
abec5bed 71
7f9fef93 72=item XXX
abec5bed 73
7f9fef93
SH
74XXX Note that deprecated modules should be listed here even if they are listed
75as an updated module in the L</Modules and Pragmata> section.
abec5bed 76
7f9fef93 77=back
c14a43b7 78
7f9fef93 79[ List each other deprecation as a =head2 entry ]
c14a43b7 80
7f9fef93 81=head1 Performance Enhancements
c14a43b7 82
7f9fef93
SH
83XXX Changes which enhance performance without changing behaviour go here.
84There may well be none in a stable release.
c14a43b7 85
7f9fef93
SH
86[ List each enhancement as a =item entry ]
87
88=over 4
c14a43b7
SH
89
90=item *
91
7f9fef93 92XXX
c14a43b7 93
7f9fef93 94=back
be39acb2 95
7f9fef93 96=head1 Modules and Pragmata
c14a43b7 97
7f9fef93
SH
98XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
99go here. If Module::CoreList is updated, generate an initial draft of the
100following sections using F<Porting/corelist-perldelta.pl>. A paragraph summary
101for important changes should then be added by hand. In an ideal world,
102dual-life modules would have a F<Changes> file that could be cribbed.
60dcce55 103
7f9fef93 104[ Within each section, list entries as a =item entry ]
60dcce55 105
7f9fef93 106=head2 New Modules and Pragmata
79a77127 107
7f9fef93 108=over 4
abec5bed
DIM
109
110=item *
111
7f9fef93 112XXX
9749148e 113
7f9fef93 114=back
9749148e 115
7f9fef93 116=head2 Updated Modules and Pragmata
9749148e 117
7f9fef93 118=over 4
abec5bed
DIM
119
120=item *
121
7f9fef93
SH
122L<XXX> has been upgraded from version A.xx to B.yy.
123
124=back
abec5bed 125
7f9fef93
SH
126=head2 Removed Modules and Pragmata
127
128=over 4
be39acb2 129
2e4abf26
DG
130=item *
131
7f9fef93 132XXX
2e4abf26 133
e5998677 134=back
83a5d6b6 135
e5998677 136=head1 Documentation
83a5d6b6 137
7f9fef93
SH
138XXX Changes to files in F<pod/> go here. Consider grouping entries by
139file and be sure to link to the appropriate page, e.g. L<perlfunc>.
338906ce 140
7f9fef93 141=head2 New Documentation
5de148ee 142
7f9fef93 143XXX Changes which create B<new> files in F<pod/> go here.
5de148ee 144
7f9fef93 145=head3 L<XXX>
5de148ee 146
7f9fef93 147XXX Description of the purpose of the new file here
5de148ee 148
7f9fef93
SH
149=head2 Changes to Existing Documentation
150
151XXX Changes which significantly change existing files in F<pod/> go here.
152However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
153section.
5de148ee 154
7f9fef93 155=head3 L<XXX>
47cb8ddb
SH
156
157=over 4
158
159=item *
160
7f9fef93 161XXX Description of the change here
47cb8ddb
SH
162
163=back
164
7f9fef93 165=head1 Diagnostics
47cb8ddb 166
7f9fef93
SH
167The following additions or changes have been made to diagnostic output,
168including warnings and fatal error messages. For the complete list of
169diagnostic messages, see L<perldiag>.
47cb8ddb 170
7f9fef93
SH
171XXX New or changed warnings emitted by the core's C<C> code go here. Also
172include any changes in L<perldiag> that reconcile it to the C<C> code.
47cb8ddb 173
7f9fef93 174=head2 New Diagnostics
47cb8ddb 175
7f9fef93
SH
176XXX Newly added diagnostic messages go under here, separated into New Errors
177and New Warnings
47cb8ddb 178
7f9fef93 179=head3 New Errors
5de148ee
SH
180
181=over 4
182
183=item *
184
7f9fef93 185XXX L<message|perldiag/"message">
5de148ee
SH
186
187=back
188
7f9fef93 189=head3 New Warnings
be39acb2
SH
190
191=over 4
192
193=item *
194
7f9fef93 195XXX L<message|perldiag/"message">
be39acb2
SH
196
197=back
198
7f9fef93
SH
199=head2 Changes to Existing Diagnostics
200
201XXX Changes (i.e. rewording) of diagnostic messages go here
be39acb2
SH
202
203=over 4
204
205=item *
206
7f9fef93 207XXX Describe change here
be39acb2
SH
208
209=back
210
7f9fef93 211=head1 Utility Changes
83a5d6b6 212
7f9fef93
SH
213XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
214Most of these are built within the directory F<utils>.
83a5d6b6 215
7f9fef93
SH
216[ List utility changes as a =head2 entry for each utility and =item
217entries for each change
218Use L<XXX> with program names to get proper documentation linking. ]
338906ce 219
7f9fef93 220=head2 L<XXX>
cd7bac54 221
b5d4d3b9 222=over 4
83b69bfd
DD
223
224=item *
225
7f9fef93 226XXX
13adb056 227
b5d4d3b9 228=back
391823f2 229
7f9fef93 230=head1 Configuration and Compilation
6c8457e9 231
7f9fef93
SH
232XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
233go here. Any other changes to the Perl build process should be listed here.
234However, any platform-specific changes should be listed in the
235L</Platform Support> section, instead.
2bf83140 236
7f9fef93 237[ List changes as a =item entry ].
041a5927 238
7f9fef93 239=over 4
69e954a5 240
7f9fef93 241=item *
86e0176a 242
7f9fef93 243XXX
69e954a5 244
e5998677 245=back
20b5e916 246
7f9fef93 247=head1 Testing
532ecd00 248
7f9fef93
SH
249XXX Any significant changes to the testing of a freshly built perl should be
250listed here. Changes which create B<new> files in F<t/> go here as do any
251large changes to the testing harness (e.g. when parallel testing was added).
252Changes to existing files in F<t/> aren't worth summarizing, although the bugs
253that they represent may be covered elsewhere.
d76c14eb 254
7f9fef93 255[ List each test improvement as a =item entry ]
d547bad0 256
e5998677 257=over 4
d547bad0 258
8a95d307
FC
259=item *
260
7f9fef93 261XXX
532ecd00 262
7f9fef93 263=back
532ecd00 264
7f9fef93 265=head1 Platform Support
532ecd00 266
7f9fef93 267XXX Any changes to platform support should be listed in the sections below.
532ecd00 268
7f9fef93
SH
269[ Within the sections, list each platform as a =item entry with specific
270changes as paragraphs below it. ]
532ecd00 271
7f9fef93 272=head2 New Platforms
532ecd00 273
7f9fef93
SH
274XXX List any platforms that this version of perl compiles on, that previous
275versions did not. These will either be enabled by new files in the F<hints/>
276directories, or new subdirectories and F<README> files at the top level of the
277source tree.
532ecd00 278
7f9fef93 279=over 4
532ecd00 280
7f9fef93 281=item XXX-some-platform
532ecd00 282
7f9fef93 283XXX
532ecd00
DM
284
285=back
286
7f9fef93 287=head2 Discontinued Platforms
338906ce 288
7f9fef93 289XXX List any platforms that this version of perl no longer compiles on.
338906ce 290
e5998677 291=over 4
338906ce 292
7f9fef93 293=item XXX-some-platform
2f304be9 294
7f9fef93 295XXX
9749148e 296
7f9fef93 297=back
9749148e 298
7f9fef93 299=head2 Platform-Specific Notes
47cb8ddb 300
7f9fef93
SH
301XXX List any changes for specific platforms. This could include configuration
302and compilation changes or changes in portability/compatibility. However,
303changes within modules for platforms should generally be listed in the
304L</Modules and Pragmata> section.
47cb8ddb 305
7f9fef93 306=over 4
47cb8ddb 307
7f9fef93 308=item XXX-some-platform
47cb8ddb 309
7f9fef93 310XXX
47cb8ddb 311
7f9fef93 312=back
47cb8ddb 313
7f9fef93 314=head1 Internal Changes
be39acb2 315
7f9fef93
SH
316XXX Changes which affect the interface available to C<XS> code go here. Other
317significant internal changes for future core maintainers should be noted as
318well.
be39acb2 319
7f9fef93 320[ List each change as a =item entry ]
be39acb2 321
7f9fef93 322=over 4
be39acb2
SH
323
324=item *
325
7f9fef93 326XXX
be39acb2 327
7f9fef93
SH
328=back
329
330=head1 Selected Bug Fixes
be39acb2 331
7f9fef93
SH
332XXX Important bug fixes in the core language are summarized here. Bug fixes in
333files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
be39acb2 334
7f9fef93 335[ List each fix as a =item entry ]
be39acb2 336
7f9fef93 337=over 4
be39acb2
SH
338
339=item *
340
7f9fef93 341XXX
be39acb2 342
7f9fef93 343=back
be39acb2 344
7f9fef93 345=head1 Known Problems
be39acb2 346
7f9fef93
SH
347XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
348tests that had to be C<TODO>ed for the release would be noted here. Unfixed
349platform specific bugs also go here.
be39acb2 350
7f9fef93
SH
351[ List each fix as a =item entry ]
352
353=over 4
be39acb2
SH
354
355=item *
356
7f9fef93 357XXX
be39acb2 358
a9c3e753 359=back
ea13b07e 360
7f9fef93 361=head1 Errata From Previous Releases
0d42058e 362
7f9fef93
SH
363=over 4
364
365=item *
2a7a05b4 366
7f9fef93
SH
367XXX Add anything here that we forgot to add, or were mistaken about, in
368the perldelta of a previous release.
2a7a05b4 369
7f9fef93
SH
370=back
371
372=head1 Obituary
2a7a05b4 373
7f9fef93
SH
374XXX If any significant core contributor has died, we've added a short obituary
375here.
2a7a05b4 376
7f9fef93 377=head1 Acknowledgements
2a7a05b4 378
7f9fef93 379XXX Generate this with:
2a7a05b4 380
7f9fef93 381 perl Porting/acknowledgements.pl v5.21.11..HEAD
f5b73711 382
44691e6f
AB
383=head1 Reporting Bugs
384
e08634c5
SH
385If you find what you think is a bug, you might check the articles recently
386posted to the comp.lang.perl.misc newsgroup and the perl bug database at
e5998677
SH
387https://rt.perl.org/ . There may also be information at
388http://www.perl.org/ , the Perl Home Page.
44691e6f 389
e08634c5
SH
390If you believe you have an unreported bug, please run the L<perlbug> program
391included with your release. Be sure to trim your bug down to a tiny but
392sufficient test case. Your bug report, along with the output of C<perl -V>,
393will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
394
395If the bug you are reporting has security implications, which make it
e08634c5
SH
396inappropriate to send to a publicly archived mailing list, then please send it
397to perl5-security-report@perl.org. This points to a closed subscription
398unarchived mailing list, which includes all the core committers, who will be
399able to help assess the impact of issues, figure out a resolution, and help
f9001595 400co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
401platforms on which Perl is supported. Please only use this address for
402security issues in the Perl core, not for modules independently distributed on
403CPAN.
44691e6f
AB
404
405=head1 SEE ALSO
406
e08634c5
SH
407The F<Changes> file for an explanation of how to view exhaustive details on
408what changed.
44691e6f
AB
409
410The F<INSTALL> file for how to build Perl.
411
412The F<README> file for general stuff.
413
414The F<Artistic> and F<Copying> files for copyright information.
415
416=cut