This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Sort list of upgraded modules in perldelta
[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
2e4abf26
DG
52=head2 Making all warnings fatal is discouraged
53
54The documentation for L<fatal warnings|warnings/Fatal Warnings> notes
55that C<< use warnings FATAL => 'all' >> is discouraged
56and provides stronger language about the risks of fatal warnings
57in general.
58
e5998677 59=head2 Module removals
b05565aa 60
e5998677 61XXX Remove this section if inapplicable.
b05565aa 62
e5998677
SH
63The following modules will be removed from the core distribution in a
64future release, and will at that time need to be installed from CPAN.
65Distributions on CPAN which require these modules will need to list them as
66prerequisites.
79116533 67
e5998677
SH
68The core versions of these modules will now issue C<"deprecated">-category
69warnings to alert you to this fact. To silence these deprecation warnings,
70install the modules in question from CPAN.
79116533 71
e5998677
SH
72Note that these are (with rare exceptions) fine modules that you are encouraged
73to continue to use. Their disinclusion from core primarily hinges on their
74necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
75not usually on concerns over their design.
79116533 76
e5998677 77=over
79116533 78
e5998677 79=item XXX
79116533 80
e5998677
SH
81XXX Note that deprecated modules should be listed here even if they are listed
82as an updated module in the L</Modules and Pragmata> section.
79116533 83
e5998677 84=back
79116533 85
e5998677 86[ List each other deprecation as a =head2 entry ]
79116533 87
e5998677 88=head1 Performance Enhancements
79116533 89
e5998677
SH
90XXX Changes which enhance performance without changing behaviour go here.
91There may well be none in a stable release.
79116533 92
e5998677 93[ List each enhancement as a =item entry ]
79116533 94
e5998677 95=over 4
79116533
SH
96
97=item *
98
e5998677 99XXX
79116533
SH
100
101=back
0939a951 102
e5998677 103=head1 Modules and Pragmata
fea59588 104
e5998677
SH
105XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
106go here. If Module::CoreList is updated, generate an initial draft of the
107following sections using F<Porting/corelist-perldelta.pl>. A paragraph summary
108for important changes should then be added by hand. In an ideal world,
109dual-life modules would have a F<Changes> file that could be cribbed.
fea59588 110
e5998677 111[ Within each section, list entries as a =item entry ]
83a5d6b6 112
e5998677 113=head2 New Modules and Pragmata
83a5d6b6 114
e5998677 115=over 4
338906ce
SH
116
117=item *
118
e5998677 119XXX
b05565aa 120
e5998677 121=back
83a5d6b6 122
e5998677 123=head2 Updated Modules and Pragmata
83a5d6b6 124
e5998677 125=over 4
e455391f
SH
126
127=item *
128
79a77127 129L<attributes> has been upgraded from version 0.26 to 0.27.
53902397 130
79a77127
SH
131=item *
132
133L<Cwd> has been upgraded from version 3.55 to 3.56.
83a5d6b6 134
abec5bed
DIM
135=item *
136
137L<ExtUtils::Miniperl> has been upgraded from version 1.04 to 1.05.
138
139=item *
140
141FindExt has been upgraded from version 1.02 to 1.03.
142
143=item *
144
60dcce55
SH
145L<IO::Socket::IP> has been upgraded from version 0.36 to 0.37.
146
147=item *
148
79a77127
SH
149L<Module::CoreList> has been upgraded from version 5.20150320 to 5.20150420.
150
151Updated to cover the latest releases of Perl.
abec5bed
DIM
152
153=item *
154
155L<PerlIO::mmap> has been upgraded from version 0.013 to 0.014.
156
157=item *
158
79a77127 159L<utf8> has been upgraded from version 1.15 to 1.16.
abec5bed 160
2e4abf26
DG
161=item *
162
163L<warnings> has been upgraded from version 1.31 to 1.32.
164
e5998677 165=back
83a5d6b6 166
e5998677 167=head2 Removed Modules and Pragmata
83a5d6b6 168
e5998677 169=over 4
83a5d6b6
SH
170
171=item *
172
e5998677 173XXX
83a5d6b6 174
e5998677 175=back
83a5d6b6 176
e5998677 177=head1 Documentation
83a5d6b6 178
e5998677
SH
179XXX Changes to files in F<pod/> go here. Consider grouping entries by
180file and be sure to link to the appropriate page, e.g. L<perlfunc>.
83a5d6b6 181
e5998677 182=head2 New Documentation
b367c45d 183
e5998677 184XXX Changes which create B<new> files in F<pod/> go here.
b367c45d 185
e5998677 186=head3 L<XXX>
b367c45d 187
e5998677 188XXX Description of the purpose of the new file here
338906ce 189
e5998677 190=head2 Changes to Existing Documentation
338906ce 191
e5998677
SH
192XXX Changes which significantly change existing files in F<pod/> go here.
193However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
194section.
83a5d6b6 195
e5998677 196=head3 L<XXX>
83a5d6b6 197
e5998677 198=over 4
83a5d6b6
SH
199
200=item *
201
e5998677 202XXX Description of the change here
83a5d6b6 203
e5998677 204=back
338906ce 205
e5998677 206=head1 Diagnostics
338906ce 207
e5998677
SH
208The following additions or changes have been made to diagnostic output,
209including warnings and fatal error messages. For the complete list of
210diagnostic messages, see L<perldiag>.
338906ce 211
e5998677
SH
212XXX New or changed warnings emitted by the core's C<C> code go here. Also
213include any changes in L<perldiag> that reconcile it to the C<C> code.
338906ce 214
e5998677 215=head2 New Diagnostics
9409f752 216
e5998677
SH
217XXX Newly added diagnostic messages go under here, separated into New Errors
218and New Warnings
9409f752 219
e5998677 220=head3 New Errors
03a97c81 221
e5998677 222=over 4
03a97c81
SH
223
224=item *
225
e5998677 226XXX L<message|perldiag/"message">
a790e348 227
e5998677 228=back
83a5d6b6 229
e5998677 230=head3 New Warnings
83a5d6b6 231
e5998677 232=over 4
126be117
JH
233
234=item *
235
e5998677 236XXX L<message|perldiag/"message">
83a5d6b6 237
a9c3e753 238=back
0939a951 239
e5998677 240=head2 Changes to Existing Diagnostics
d2fff9f6 241
e5998677 242XXX Changes (i.e. rewording) of diagnostic messages go here
e329daf3 243
cd7bac54 244=over 4
e329daf3 245
cd7bac54 246=item *
e329daf3 247
e5998677 248XXX Describe change here
83a5d6b6
SH
249
250=back
251
e5998677 252=head1 Utility Changes
83a5d6b6 253
e5998677
SH
254XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
255Most of these are built within the directory F<utils>.
83a5d6b6 256
e5998677
SH
257[ List utility changes as a =head2 entry for each utility and =item
258entries for each change
259Use L<XXX> with program names to get proper documentation linking. ]
83a5d6b6 260
e5998677 261=head2 L<XXX>
83a5d6b6
SH
262
263=over 4
264
265=item *
266
e5998677 267XXX
ba31029d 268
cd7bac54
S
269=back
270
e5998677 271=head1 Configuration and Compilation
cd7bac54 272
e5998677
SH
273XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
274go here. Any other changes to the Perl build process should be listed here.
275However, any platform-specific changes should be listed in the
276L</Platform Support> section, instead.
cd7bac54 277
e5998677 278[ List changes as a =item entry ].
cd7bac54
S
279
280=over 4
281
282=item *
283
e5998677 284XXX
cd7bac54
S
285
286=back
541e1e0d 287
a9c3e753 288=head1 Testing
cd7bac54 289
e5998677
SH
290XXX Any significant changes to the testing of a freshly built perl should be
291listed here. Changes which create B<new> files in F<t/> go here as do any
292large changes to the testing harness (e.g. when parallel testing was added).
293Changes to existing files in F<t/> aren't worth summarizing, although the bugs
294that they represent may be covered elsewhere.
295
296[ List each test improvement as a =item entry ]
297
b5d4d3b9 298=over 4
83b69bfd
DD
299
300=item *
301
e5998677 302XXX
13adb056 303
b5d4d3b9 304=back
391823f2 305
a9c3e753 306=head1 Platform Support
6c8457e9 307
e5998677 308XXX Any changes to platform support should be listed in the sections below.
fdcaecb7 309
e5998677
SH
310[ Within the sections, list each platform as a =item entry with specific
311changes as paragraphs below it. ]
ce1e892e 312
e5998677 313=head2 New Platforms
2af7c6b6 314
e5998677
SH
315XXX List any platforms that this version of perl compiles on, that previous
316versions did not. These will either be enabled by new files in the F<hints/>
317directories, or new subdirectories and F<README> files at the top level of the
318source tree.
8c847e66 319
2ff1ebfe 320=over 4
d345f487 321
e5998677 322=item XXX-some-platform
d345f487 323
e5998677 324XXX
cd7bac54 325
4dc623f0 326=back
353075a0 327
e5998677 328=head2 Discontinued Platforms
9f122eef 329
e5998677 330XXX List any platforms that this version of perl no longer compiles on.
2ec11c70 331
e5998677 332=over 4
2ec11c70 333
e5998677 334=item XXX-some-platform
2683609f 335
e5998677 336XXX
338906ce 337
4dc623f0 338=back
c7f058f0 339
e5998677 340=head2 Platform-Specific Notes
2bf83140 341
e5998677
SH
342XXX List any changes for specific platforms. This could include configuration
343and compilation changes or changes in portability/compatibility. However,
344changes within modules for platforms should generally be listed in the
345L</Modules and Pragmata> section.
041a5927 346
e5998677 347=over 4
041a5927 348
e5998677 349=item XXX-some-platform
69e954a5 350
e5998677 351XXX
69e954a5 352
e5998677 353=back
20b5e916 354
e5998677 355=head1 Internal Changes
d76c14eb 356
e5998677
SH
357XXX Changes which affect the interface available to C<XS> code go here. Other
358significant internal changes for future core maintainers should be noted as
359well.
d76c14eb 360
e5998677 361[ List each change as a =item entry ]
d547bad0 362
e5998677 363=over 4
d547bad0 364
8a95d307
FC
365=item *
366
e5998677 367XXX
8a95d307 368
e5998677 369=back
338906ce 370
e5998677 371=head1 Selected Bug Fixes
338906ce 372
e5998677
SH
373XXX Important bug fixes in the core language are summarized here. Bug fixes in
374files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
338906ce 375
e5998677 376[ List each fix as a =item entry ]
338906ce 377
e5998677 378=over 4
338906ce
SH
379
380=item *
381
e5998677 382XXX
2f304be9 383
a9c3e753 384=back
ea13b07e 385
a9c3e753 386=head1 Known Problems
b65adbec 387
e5998677
SH
388XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
389tests that had to be C<TODO>ed for the release would be noted here. Unfixed
390platform specific bugs also go here.
b94c7836 391
e5998677 392[ List each fix as a =item entry ]
ce1e892e
KW
393
394=over 4
395
396=item *
397
e5998677 398XXX
ce1e892e 399
e5998677 400=back
ce1e892e 401
e5998677 402=head1 Errata From Previous Releases
ce1e892e 403
e5998677 404=over 4
ce1e892e 405
e5998677 406=item *
ce1e892e 407
e5998677
SH
408XXX Add anything here that we forgot to add, or were mistaken about, in
409the perldelta of a previous release.
ce1e892e 410
a9c3e753 411=back
e3e8f263 412
e5998677 413=head1 Obituary
0d42058e 414
e5998677
SH
415XXX If any significant core contributor has died, we've added a short obituary
416here.
0d42058e 417
e5998677 418=head1 Acknowledgements
0d42058e 419
e5998677 420XXX Generate this with:
0d42058e 421
e5998677 422 perl Porting/acknowledgements.pl v5.21.10..HEAD
f5b73711 423
44691e6f
AB
424=head1 Reporting Bugs
425
e08634c5
SH
426If you find what you think is a bug, you might check the articles recently
427posted to the comp.lang.perl.misc newsgroup and the perl bug database at
e5998677
SH
428https://rt.perl.org/ . There may also be information at
429http://www.perl.org/ , the Perl Home Page.
44691e6f 430
e08634c5
SH
431If you believe you have an unreported bug, please run the L<perlbug> program
432included with your release. Be sure to trim your bug down to a tiny but
433sufficient test case. Your bug report, along with the output of C<perl -V>,
434will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
435
436If the bug you are reporting has security implications, which make it
e08634c5
SH
437inappropriate to send to a publicly archived mailing list, then please send it
438to perl5-security-report@perl.org. This points to a closed subscription
439unarchived mailing list, which includes all the core committers, who will be
440able to help assess the impact of issues, figure out a resolution, and help
f9001595 441co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
442platforms on which Perl is supported. Please only use this address for
443security issues in the Perl core, not for modules independently distributed on
444CPAN.
44691e6f
AB
445
446=head1 SEE ALSO
447
e08634c5
SH
448The F<Changes> file for an explanation of how to view exhaustive details on
449what changed.
44691e6f
AB
450
451The F<INSTALL> file for how to build Perl.
452
453The F<README> file for general stuff.
454
455The F<Artistic> and F<Copying> files for copyright information.
456
457=cut