This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Prepare Module::CoreList for 5.21.11 (if that happens)
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
e5998677
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.11
c68523cb 9
238894db 10=head1 DESCRIPTION
c68523cb 11
e5998677 12This document describes differences between the 5.21.10 release and the 5.21.11
238894db 13release.
c68523cb 14
e5998677
SH
15If you are upgrading from an earlier release such as 5.21.9, first read
16L<perl52110delta>, which describes differences between 5.21.9 and 5.21.10.
2ec11c70 17
e5998677 18=head1 Notice
ef8784b7 19
e5998677 20XXX Any important notices here
6798c95d 21
e5998677 22=head1 Core Enhancements
6798c95d 23
e5998677
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.
cd7bac54 27
e5998677 28[ List each enhancement as a =head2 entry ]
cd7bac54 29
e5998677 30=head1 Security
0939a951 31
e5998677
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.
cd7bac54 35
e5998677 36[ List each security issue as a =head2 entry ]
cd7bac54 37
e5998677 38=head1 Incompatible Changes
cd7bac54 39
e5998677 40XXX For a release on a stable branch, this section aspires to be:
83a5d6b6 41
e5998677
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.
83a5d6b6 45
e5998677 46[ List each incompatible change as a =head2 entry ]
b9c683b3 47
e5998677 48=head1 Deprecations
b9c683b3 49
e5998677 50XXX Any deprecated features, syntax, modules etc. should be listed here.
b9c683b3 51
e5998677 52=head2 Module removals
b05565aa 53
e5998677 54XXX Remove this section if inapplicable.
b05565aa 55
e5998677
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.
79116533 60
e5998677
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.
79116533 64
e5998677
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.
79116533 69
e5998677 70=over
79116533 71
e5998677 72=item XXX
79116533 73
e5998677
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.
79116533 76
e5998677 77=back
79116533 78
e5998677 79[ List each other deprecation as a =head2 entry ]
79116533 80
e5998677 81=head1 Performance Enhancements
79116533 82
e5998677
SH
83XXX Changes which enhance performance without changing behaviour go here.
84There may well be none in a stable release.
79116533 85
e5998677 86[ List each enhancement as a =item entry ]
79116533 87
e5998677 88=over 4
79116533
SH
89
90=item *
91
e5998677 92XXX
79116533
SH
93
94=back
0939a951 95
e5998677 96=head1 Modules and Pragmata
fea59588 97
e5998677
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.
fea59588 103
e5998677 104[ Within each section, list entries as a =item entry ]
83a5d6b6 105
e5998677 106=head2 New Modules and Pragmata
83a5d6b6 107
e5998677 108=over 4
338906ce
SH
109
110=item *
111
e5998677 112XXX
b05565aa 113
e5998677 114=back
83a5d6b6 115
e5998677 116=head2 Updated Modules and Pragmata
83a5d6b6 117
e5998677 118=over 4
e455391f
SH
119
120=item *
121
53902397
SH
122L<Module::CoreList> has been upgraded from version 5.20150320 to 5.20150420.
123
124Updated to cover the latest releases of Perl.
83a5d6b6 125
e5998677 126=back
83a5d6b6 127
e5998677 128=head2 Removed Modules and Pragmata
83a5d6b6 129
e5998677 130=over 4
83a5d6b6
SH
131
132=item *
133
e5998677 134XXX
83a5d6b6 135
e5998677 136=back
83a5d6b6 137
e5998677 138=head1 Documentation
83a5d6b6 139
e5998677
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>.
83a5d6b6 142
e5998677 143=head2 New Documentation
b367c45d 144
e5998677 145XXX Changes which create B<new> files in F<pod/> go here.
b367c45d 146
e5998677 147=head3 L<XXX>
b367c45d 148
e5998677 149XXX Description of the purpose of the new file here
338906ce 150
e5998677 151=head2 Changes to Existing Documentation
338906ce 152
e5998677
SH
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.
83a5d6b6 156
e5998677 157=head3 L<XXX>
83a5d6b6 158
e5998677 159=over 4
83a5d6b6
SH
160
161=item *
162
e5998677 163XXX Description of the change here
83a5d6b6 164
e5998677 165=back
338906ce 166
e5998677 167=head1 Diagnostics
338906ce 168
e5998677
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>.
338906ce 172
e5998677
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.
338906ce 175
e5998677 176=head2 New Diagnostics
9409f752 177
e5998677
SH
178XXX Newly added diagnostic messages go under here, separated into New Errors
179and New Warnings
9409f752 180
e5998677 181=head3 New Errors
03a97c81 182
e5998677 183=over 4
03a97c81
SH
184
185=item *
186
e5998677 187XXX L<message|perldiag/"message">
a790e348 188
e5998677 189=back
83a5d6b6 190
e5998677 191=head3 New Warnings
83a5d6b6 192
e5998677 193=over 4
126be117
JH
194
195=item *
196
e5998677 197XXX L<message|perldiag/"message">
83a5d6b6 198
a9c3e753 199=back
0939a951 200
e5998677 201=head2 Changes to Existing Diagnostics
d2fff9f6 202
e5998677 203XXX Changes (i.e. rewording) of diagnostic messages go here
e329daf3 204
cd7bac54 205=over 4
e329daf3 206
cd7bac54 207=item *
e329daf3 208
e5998677 209XXX Describe change here
83a5d6b6
SH
210
211=back
212
e5998677 213=head1 Utility Changes
83a5d6b6 214
e5998677
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
e5998677
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. ]
83a5d6b6 221
e5998677 222=head2 L<XXX>
83a5d6b6
SH
223
224=over 4
225
226=item *
227
e5998677 228XXX
ba31029d 229
cd7bac54
S
230=back
231
e5998677 232=head1 Configuration and Compilation
cd7bac54 233
e5998677
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.
cd7bac54 238
e5998677 239[ List changes as a =item entry ].
cd7bac54
S
240
241=over 4
242
243=item *
244
e5998677 245XXX
cd7bac54
S
246
247=back
541e1e0d 248
a9c3e753 249=head1 Testing
cd7bac54 250
e5998677
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.
256
257[ List each test improvement as a =item entry ]
258
b5d4d3b9 259=over 4
83b69bfd
DD
260
261=item *
262
e5998677 263XXX
13adb056 264
b5d4d3b9 265=back
391823f2 266
a9c3e753 267=head1 Platform Support
6c8457e9 268
e5998677 269XXX Any changes to platform support should be listed in the sections below.
fdcaecb7 270
e5998677
SH
271[ Within the sections, list each platform as a =item entry with specific
272changes as paragraphs below it. ]
ce1e892e 273
e5998677 274=head2 New Platforms
2af7c6b6 275
e5998677
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.
8c847e66 280
2ff1ebfe 281=over 4
d345f487 282
e5998677 283=item XXX-some-platform
d345f487 284
e5998677 285XXX
cd7bac54 286
4dc623f0 287=back
353075a0 288
e5998677 289=head2 Discontinued Platforms
9f122eef 290
e5998677 291XXX List any platforms that this version of perl no longer compiles on.
2ec11c70 292
e5998677 293=over 4
2ec11c70 294
e5998677 295=item XXX-some-platform
2683609f 296
e5998677 297XXX
338906ce 298
4dc623f0 299=back
c7f058f0 300
e5998677 301=head2 Platform-Specific Notes
2bf83140 302
e5998677
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.
041a5927 307
e5998677 308=over 4
041a5927 309
e5998677 310=item XXX-some-platform
69e954a5 311
e5998677 312XXX
69e954a5 313
e5998677 314=back
20b5e916 315
e5998677 316=head1 Internal Changes
d76c14eb 317
e5998677
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.
d76c14eb 321
e5998677 322[ List each change as a =item entry ]
d547bad0 323
e5998677 324=over 4
d547bad0 325
8a95d307
FC
326=item *
327
e5998677 328XXX
8a95d307 329
e5998677 330=back
338906ce 331
e5998677 332=head1 Selected Bug Fixes
338906ce 333
e5998677
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>.
338906ce 336
e5998677 337[ List each fix as a =item entry ]
338906ce 338
e5998677 339=over 4
338906ce
SH
340
341=item *
342
e5998677 343XXX
2f304be9 344
a9c3e753 345=back
ea13b07e 346
a9c3e753 347=head1 Known Problems
b65adbec 348
e5998677
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.
b94c7836 352
e5998677 353[ List each fix as a =item entry ]
ce1e892e
KW
354
355=over 4
356
357=item *
358
e5998677 359XXX
ce1e892e 360
e5998677 361=back
ce1e892e 362
e5998677 363=head1 Errata From Previous Releases
ce1e892e 364
e5998677 365=over 4
ce1e892e 366
e5998677 367=item *
ce1e892e 368
e5998677
SH
369XXX Add anything here that we forgot to add, or were mistaken about, in
370the perldelta of a previous release.
ce1e892e 371
a9c3e753 372=back
e3e8f263 373
e5998677 374=head1 Obituary
0d42058e 375
e5998677
SH
376XXX If any significant core contributor has died, we've added a short obituary
377here.
0d42058e 378
e5998677 379=head1 Acknowledgements
0d42058e 380
e5998677 381XXX Generate this with:
0d42058e 382
e5998677 383 perl Porting/acknowledgements.pl v5.21.10..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