This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Prepare Module::CoreList 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
6bb5549b
SH
122L<Module::CoreList> has been upgraded from version 5.20150420 to 5.20150520.
123
124Updated to cover the latest releases of Perl.
7f9fef93
SH
125
126=back
abec5bed 127
7f9fef93
SH
128=head2 Removed Modules and Pragmata
129
130=over 4
be39acb2 131
2e4abf26
DG
132=item *
133
7f9fef93 134XXX
2e4abf26 135
e5998677 136=back
83a5d6b6 137
e5998677 138=head1 Documentation
83a5d6b6 139
7f9fef93
SH
140XXX Changes to files in F<pod/> go here. Consider grouping entries by
141file and be sure to link to the appropriate page, e.g. L<perlfunc>.
338906ce 142
7f9fef93 143=head2 New Documentation
5de148ee 144
7f9fef93 145XXX Changes which create B<new> files in F<pod/> go here.
5de148ee 146
7f9fef93 147=head3 L<XXX>
5de148ee 148
7f9fef93 149XXX Description of the purpose of the new file here
5de148ee 150
7f9fef93
SH
151=head2 Changes to Existing Documentation
152
153XXX Changes which significantly change existing files in F<pod/> go here.
154However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
155section.
5de148ee 156
7f9fef93 157=head3 L<XXX>
47cb8ddb
SH
158
159=over 4
160
161=item *
162
7f9fef93 163XXX Description of the change here
47cb8ddb
SH
164
165=back
166
7f9fef93 167=head1 Diagnostics
47cb8ddb 168
7f9fef93
SH
169The following additions or changes have been made to diagnostic output,
170including warnings and fatal error messages. For the complete list of
171diagnostic messages, see L<perldiag>.
47cb8ddb 172
7f9fef93
SH
173XXX New or changed warnings emitted by the core's C<C> code go here. Also
174include any changes in L<perldiag> that reconcile it to the C<C> code.
47cb8ddb 175
7f9fef93 176=head2 New Diagnostics
47cb8ddb 177
7f9fef93
SH
178XXX Newly added diagnostic messages go under here, separated into New Errors
179and New Warnings
47cb8ddb 180
7f9fef93 181=head3 New Errors
5de148ee
SH
182
183=over 4
184
185=item *
186
7f9fef93 187XXX L<message|perldiag/"message">
5de148ee
SH
188
189=back
190
7f9fef93 191=head3 New Warnings
be39acb2
SH
192
193=over 4
194
195=item *
196
7f9fef93 197XXX L<message|perldiag/"message">
be39acb2
SH
198
199=back
200
7f9fef93
SH
201=head2 Changes to Existing Diagnostics
202
203XXX Changes (i.e. rewording) of diagnostic messages go here
be39acb2
SH
204
205=over 4
206
207=item *
208
7f9fef93 209XXX Describe change here
be39acb2
SH
210
211=back
212
7f9fef93 213=head1 Utility Changes
83a5d6b6 214
7f9fef93
SH
215XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
216Most of these are built within the directory F<utils>.
83a5d6b6 217
7f9fef93
SH
218[ List utility changes as a =head2 entry for each utility and =item
219entries for each change
220Use L<XXX> with program names to get proper documentation linking. ]
338906ce 221
7f9fef93 222=head2 L<XXX>
cd7bac54 223
b5d4d3b9 224=over 4
83b69bfd
DD
225
226=item *
227
7f9fef93 228XXX
13adb056 229
b5d4d3b9 230=back
391823f2 231
7f9fef93 232=head1 Configuration and Compilation
6c8457e9 233
7f9fef93
SH
234XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
235go here. Any other changes to the Perl build process should be listed here.
236However, any platform-specific changes should be listed in the
237L</Platform Support> section, instead.
2bf83140 238
7f9fef93 239[ List changes as a =item entry ].
041a5927 240
7f9fef93 241=over 4
69e954a5 242
7f9fef93 243=item *
86e0176a 244
7f9fef93 245XXX
69e954a5 246
e5998677 247=back
20b5e916 248
7f9fef93 249=head1 Testing
532ecd00 250
7f9fef93
SH
251XXX Any significant changes to the testing of a freshly built perl should be
252listed here. Changes which create B<new> files in F<t/> go here as do any
253large changes to the testing harness (e.g. when parallel testing was added).
254Changes to existing files in F<t/> aren't worth summarizing, although the bugs
255that they represent may be covered elsewhere.
d76c14eb 256
7f9fef93 257[ List each test improvement as a =item entry ]
d547bad0 258
e5998677 259=over 4
d547bad0 260
8a95d307
FC
261=item *
262
7f9fef93 263XXX
532ecd00 264
7f9fef93 265=back
532ecd00 266
7f9fef93 267=head1 Platform Support
532ecd00 268
7f9fef93 269XXX Any changes to platform support should be listed in the sections below.
532ecd00 270
7f9fef93
SH
271[ Within the sections, list each platform as a =item entry with specific
272changes as paragraphs below it. ]
532ecd00 273
7f9fef93 274=head2 New Platforms
532ecd00 275
7f9fef93
SH
276XXX List any platforms that this version of perl compiles on, that previous
277versions did not. These will either be enabled by new files in the F<hints/>
278directories, or new subdirectories and F<README> files at the top level of the
279source tree.
532ecd00 280
7f9fef93 281=over 4
532ecd00 282
7f9fef93 283=item XXX-some-platform
532ecd00 284
7f9fef93 285XXX
532ecd00
DM
286
287=back
288
7f9fef93 289=head2 Discontinued Platforms
338906ce 290
7f9fef93 291XXX List any platforms that this version of perl no longer compiles on.
338906ce 292
e5998677 293=over 4
338906ce 294
7f9fef93 295=item XXX-some-platform
2f304be9 296
7f9fef93 297XXX
9749148e 298
7f9fef93 299=back
9749148e 300
7f9fef93 301=head2 Platform-Specific Notes
47cb8ddb 302
7f9fef93
SH
303XXX List any changes for specific platforms. This could include configuration
304and compilation changes or changes in portability/compatibility. However,
305changes within modules for platforms should generally be listed in the
306L</Modules and Pragmata> section.
47cb8ddb 307
7f9fef93 308=over 4
47cb8ddb 309
7f9fef93 310=item XXX-some-platform
47cb8ddb 311
7f9fef93 312XXX
47cb8ddb 313
7f9fef93 314=back
47cb8ddb 315
7f9fef93 316=head1 Internal Changes
be39acb2 317
7f9fef93
SH
318XXX Changes which affect the interface available to C<XS> code go here. Other
319significant internal changes for future core maintainers should be noted as
320well.
be39acb2 321
7f9fef93 322[ List each change as a =item entry ]
be39acb2 323
7f9fef93 324=over 4
be39acb2
SH
325
326=item *
327
7f9fef93 328XXX
be39acb2 329
7f9fef93
SH
330=back
331
332=head1 Selected Bug Fixes
be39acb2 333
7f9fef93
SH
334XXX Important bug fixes in the core language are summarized here. Bug fixes in
335files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
be39acb2 336
7f9fef93 337[ List each fix as a =item entry ]
be39acb2 338
7f9fef93 339=over 4
be39acb2
SH
340
341=item *
342
7f9fef93 343XXX
be39acb2 344
7f9fef93 345=back
be39acb2 346
7f9fef93 347=head1 Known Problems
be39acb2 348
7f9fef93
SH
349XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
350tests that had to be C<TODO>ed for the release would be noted here. Unfixed
351platform specific bugs also go here.
be39acb2 352
7f9fef93
SH
353[ List each fix as a =item entry ]
354
355=over 4
be39acb2
SH
356
357=item *
358
7f9fef93 359XXX
be39acb2 360
a9c3e753 361=back
ea13b07e 362
7f9fef93 363=head1 Errata From Previous Releases
0d42058e 364
7f9fef93
SH
365=over 4
366
367=item *
2a7a05b4 368
7f9fef93
SH
369XXX Add anything here that we forgot to add, or were mistaken about, in
370the perldelta of a previous release.
2a7a05b4 371
7f9fef93
SH
372=back
373
374=head1 Obituary
2a7a05b4 375
7f9fef93
SH
376XXX If any significant core contributor has died, we've added a short obituary
377here.
2a7a05b4 378
7f9fef93 379=head1 Acknowledgements
2a7a05b4 380
7f9fef93 381XXX Generate this with:
2a7a05b4 382
7f9fef93 383 perl Porting/acknowledgements.pl v5.21.11..HEAD
f5b73711 384
44691e6f
AB
385=head1 Reporting Bugs
386
e08634c5
SH
387If you find what you think is a bug, you might check the articles recently
388posted to the comp.lang.perl.misc newsgroup and the perl bug database at
e5998677
SH
389https://rt.perl.org/ . There may also be information at
390http://www.perl.org/ , the Perl Home Page.
44691e6f 391
e08634c5
SH
392If you believe you have an unreported bug, please run the L<perlbug> program
393included with your release. Be sure to trim your bug down to a tiny but
394sufficient test case. Your bug report, along with the output of C<perl -V>,
395will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
396
397If the bug you are reporting has security implications, which make it
e08634c5
SH
398inappropriate to send to a publicly archived mailing list, then please send it
399to perl5-security-report@perl.org. This points to a closed subscription
400unarchived mailing list, which includes all the core committers, who will be
401able to help assess the impact of issues, figure out a resolution, and help
f9001595 402co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
403platforms on which Perl is supported. Please only use this address for
404security issues in the Perl core, not for modules independently distributed on
405CPAN.
44691e6f
AB
406
407=head1 SEE ALSO
408
e08634c5
SH
409The F<Changes> file for an explanation of how to view exhaustive details on
410what changed.
44691e6f
AB
411
412The F<INSTALL> file for how to build Perl.
413
414The F<README> file for general stuff.
415
416The F<Artistic> and F<Copying> files for copyright information.
417
418=cut