This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
bump perl5db.pl's $VERSION
[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
60dcce55
SH
141L<IO::Socket::IP> has been upgraded from version 0.36 to 0.37.
142
143=item *
144
79a77127
SH
145L<Module::CoreList> has been upgraded from version 5.20150320 to 5.20150420.
146
147Updated to cover the latest releases of Perl.
abec5bed
DIM
148
149=item *
150
151L<PerlIO::mmap> has been upgraded from version 0.013 to 0.014.
152
153=item *
154
79a77127 155L<utf8> has been upgraded from version 1.15 to 1.16.
abec5bed 156
2e4abf26
DG
157=item *
158
159L<warnings> has been upgraded from version 1.31 to 1.32.
160
81baec77
JK
161=item *
162
163L<ExtUtils::ParseXS> has been upgraded from version 3.27 (with certain
164components which were at version 3.25) to version 3.28.
165
e5998677 166=back
83a5d6b6 167
e5998677 168=head2 Removed Modules and Pragmata
83a5d6b6 169
e5998677 170=over 4
83a5d6b6
SH
171
172=item *
173
e5998677 174XXX
83a5d6b6 175
e5998677 176=back
83a5d6b6 177
e5998677 178=head1 Documentation
83a5d6b6 179
e5998677
SH
180XXX Changes to files in F<pod/> go here. Consider grouping entries by
181file and be sure to link to the appropriate page, e.g. L<perlfunc>.
83a5d6b6 182
e5998677 183=head2 New Documentation
b367c45d 184
e5998677 185XXX Changes which create B<new> files in F<pod/> go here.
b367c45d 186
e5998677 187=head3 L<XXX>
b367c45d 188
e5998677 189XXX Description of the purpose of the new file here
338906ce 190
e5998677 191=head2 Changes to Existing Documentation
338906ce 192
e5998677
SH
193XXX Changes which significantly change existing files in F<pod/> go here.
194However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
195section.
83a5d6b6 196
e5998677 197=head3 L<XXX>
83a5d6b6 198
e5998677 199=over 4
83a5d6b6
SH
200
201=item *
202
e5998677 203XXX Description of the change here
83a5d6b6 204
e5998677 205=back
338906ce 206
e5998677 207=head1 Diagnostics
338906ce 208
e5998677
SH
209The following additions or changes have been made to diagnostic output,
210including warnings and fatal error messages. For the complete list of
211diagnostic messages, see L<perldiag>.
338906ce 212
e5998677
SH
213XXX New or changed warnings emitted by the core's C<C> code go here. Also
214include any changes in L<perldiag> that reconcile it to the C<C> code.
338906ce 215
e5998677 216=head2 New Diagnostics
9409f752 217
e5998677
SH
218XXX Newly added diagnostic messages go under here, separated into New Errors
219and New Warnings
9409f752 220
e5998677 221=head3 New Errors
03a97c81 222
e5998677 223=over 4
03a97c81
SH
224
225=item *
226
e5998677 227XXX L<message|perldiag/"message">
a790e348 228
e5998677 229=back
83a5d6b6 230
e5998677 231=head3 New Warnings
83a5d6b6 232
e5998677 233=over 4
126be117
JH
234
235=item *
236
e5998677 237XXX L<message|perldiag/"message">
83a5d6b6 238
a9c3e753 239=back
0939a951 240
e5998677 241=head2 Changes to Existing Diagnostics
d2fff9f6 242
e5998677 243XXX Changes (i.e. rewording) of diagnostic messages go here
e329daf3 244
cd7bac54 245=over 4
e329daf3 246
cd7bac54 247=item *
e329daf3 248
e5998677 249XXX Describe change here
83a5d6b6
SH
250
251=back
252
e5998677 253=head1 Utility Changes
83a5d6b6 254
e5998677
SH
255XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
256Most of these are built within the directory F<utils>.
83a5d6b6 257
e5998677
SH
258[ List utility changes as a =head2 entry for each utility and =item
259entries for each change
260Use L<XXX> with program names to get proper documentation linking. ]
83a5d6b6 261
e5998677 262=head2 L<XXX>
83a5d6b6
SH
263
264=over 4
265
266=item *
267
e5998677 268XXX
ba31029d 269
cd7bac54
S
270=back
271
e5998677 272=head1 Configuration and Compilation
cd7bac54 273
e5998677
SH
274XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
275go here. Any other changes to the Perl build process should be listed here.
276However, any platform-specific changes should be listed in the
277L</Platform Support> section, instead.
cd7bac54 278
e5998677 279[ List changes as a =item entry ].
cd7bac54
S
280
281=over 4
282
283=item *
284
e5998677 285XXX
cd7bac54
S
286
287=back
541e1e0d 288
a9c3e753 289=head1 Testing
cd7bac54 290
e5998677
SH
291XXX Any significant changes to the testing of a freshly built perl should be
292listed here. Changes which create B<new> files in F<t/> go here as do any
293large changes to the testing harness (e.g. when parallel testing was added).
294Changes to existing files in F<t/> aren't worth summarizing, although the bugs
295that they represent may be covered elsewhere.
296
297[ List each test improvement as a =item entry ]
298
b5d4d3b9 299=over 4
83b69bfd
DD
300
301=item *
302
e5998677 303XXX
13adb056 304
b5d4d3b9 305=back
391823f2 306
a9c3e753 307=head1 Platform Support
6c8457e9 308
e5998677 309XXX Any changes to platform support should be listed in the sections below.
fdcaecb7 310
e5998677
SH
311[ Within the sections, list each platform as a =item entry with specific
312changes as paragraphs below it. ]
ce1e892e 313
e5998677 314=head2 New Platforms
2af7c6b6 315
e5998677
SH
316XXX List any platforms that this version of perl compiles on, that previous
317versions did not. These will either be enabled by new files in the F<hints/>
318directories, or new subdirectories and F<README> files at the top level of the
319source tree.
8c847e66 320
2ff1ebfe 321=over 4
d345f487 322
e5998677 323=item XXX-some-platform
d345f487 324
e5998677 325XXX
cd7bac54 326
4dc623f0 327=back
353075a0 328
e5998677 329=head2 Discontinued Platforms
9f122eef 330
e5998677 331XXX List any platforms that this version of perl no longer compiles on.
2ec11c70 332
e5998677 333=over 4
2ec11c70 334
e5998677 335=item XXX-some-platform
2683609f 336
e5998677 337XXX
338906ce 338
4dc623f0 339=back
c7f058f0 340
e5998677 341=head2 Platform-Specific Notes
2bf83140 342
e5998677
SH
343XXX List any changes for specific platforms. This could include configuration
344and compilation changes or changes in portability/compatibility. However,
345changes within modules for platforms should generally be listed in the
346L</Modules and Pragmata> section.
041a5927 347
e5998677 348=over 4
041a5927 349
86e0176a 350=item Win32
69e954a5 351
86e0176a
TC
352F<miniperl.exe> is now built with C<-fno-strict-aliasing>, allowing
35364-bit builds to complete on GCC 4.8. [perl #123976]
354
355C<test-prep> again depends on C<test-prep-gcc> for GCC builds. [perl
356#124221]
69e954a5 357
e5998677 358=back
20b5e916 359
e5998677 360=head1 Internal Changes
d76c14eb 361
e5998677
SH
362XXX Changes which affect the interface available to C<XS> code go here. Other
363significant internal changes for future core maintainers should be noted as
364well.
d76c14eb 365
e5998677 366[ List each change as a =item entry ]
d547bad0 367
e5998677 368=over 4
d547bad0 369
8a95d307
FC
370=item *
371
e5998677 372XXX
8a95d307 373
e5998677 374=back
338906ce 375
e5998677 376=head1 Selected Bug Fixes
338906ce 377
e5998677
SH
378XXX Important bug fixes in the core language are summarized here. Bug fixes in
379files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
338906ce 380
e5998677 381[ List each fix as a =item entry ]
338906ce 382
e5998677 383=over 4
338906ce
SH
384
385=item *
386
e42530d2
TC
387C<pack("D", $x)> and C<pack("F", $x)> now zero the padding on x86 long
388double builds. GCC 4.8 and later, under some build options, would
389either overwrite the zero-initialized padding, or bypass the
390initialized buffer entirely. This caused F<op/pack.t> to fail. [perl
391#123971]
2f304be9 392
a9c3e753 393=back
ea13b07e 394
a9c3e753 395=head1 Known Problems
b65adbec 396
e5998677
SH
397XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
398tests that had to be C<TODO>ed for the release would be noted here. Unfixed
399platform specific bugs also go here.
b94c7836 400
e5998677 401[ List each fix as a =item entry ]
ce1e892e
KW
402
403=over 4
404
405=item *
406
e5998677 407XXX
ce1e892e 408
e5998677 409=back
ce1e892e 410
e5998677 411=head1 Errata From Previous Releases
ce1e892e 412
e5998677 413=over 4
ce1e892e 414
e5998677 415=item *
ce1e892e 416
e5998677
SH
417XXX Add anything here that we forgot to add, or were mistaken about, in
418the perldelta of a previous release.
ce1e892e 419
a9c3e753 420=back
e3e8f263 421
e5998677 422=head1 Obituary
0d42058e 423
e5998677
SH
424XXX If any significant core contributor has died, we've added a short obituary
425here.
0d42058e 426
e5998677 427=head1 Acknowledgements
0d42058e 428
e5998677 429XXX Generate this with:
0d42058e 430
e5998677 431 perl Porting/acknowledgements.pl v5.21.10..HEAD
f5b73711 432
44691e6f
AB
433=head1 Reporting Bugs
434
e08634c5
SH
435If you find what you think is a bug, you might check the articles recently
436posted to the comp.lang.perl.misc newsgroup and the perl bug database at
e5998677
SH
437https://rt.perl.org/ . There may also be information at
438http://www.perl.org/ , the Perl Home Page.
44691e6f 439
e08634c5
SH
440If you believe you have an unreported bug, please run the L<perlbug> program
441included with your release. Be sure to trim your bug down to a tiny but
442sufficient test case. Your bug report, along with the output of C<perl -V>,
443will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
444
445If the bug you are reporting has security implications, which make it
e08634c5
SH
446inappropriate to send to a publicly archived mailing list, then please send it
447to perl5-security-report@perl.org. This points to a closed subscription
448unarchived mailing list, which includes all the core committers, who will be
449able to help assess the impact of issues, figure out a resolution, and help
f9001595 450co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
451platforms on which Perl is supported. Please only use this address for
452security issues in the Perl core, not for modules independently distributed on
453CPAN.
44691e6f
AB
454
455=head1 SEE ALSO
456
e08634c5
SH
457The F<Changes> file for an explanation of how to view exhaustive details on
458what changed.
44691e6f
AB
459
460The F<INSTALL> file for how to build Perl.
461
462The F<README> file for general stuff.
463
464The F<Artistic> and F<Copying> files for copyright information.
465
466=cut