This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Carp::Heavy is no longer customized
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
a9c3e753
S
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.10
c68523cb 9
238894db 10=head1 DESCRIPTION
c68523cb 11
a9c3e753 12This document describes differences between the 5.21.9 release and the 5.21.10
238894db 13release.
c68523cb 14
a9c3e753
S
15If you are upgrading from an earlier release such as 5.21.8, first read
16L<perl5219delta>, which describes differences between 5.21.8 and 5.21.9.
2ec11c70 17
b5d4d3b9 18=head1 Notice
2ec11c70 19
a9c3e753 20XXX Any important notices here
67f2cc75 21
b5d4d3b9 22=head1 Core Enhancements
67f2cc75 23
a9c3e753
S
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.
06ae2722 27
a9c3e753 28[ List each enhancement as a =head2 entry ]
156f41cf 29
a9c3e753 30=head1 Security
156f41cf 31
a9c3e753
S
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.
156f41cf 35
a9c3e753 36[ List each security issue as a =head2 entry ]
48c4d243 37
b5d4d3b9 38=head1 Incompatible Changes
ef8784b7 39
a9c3e753 40XXX For a release on a stable branch, this section aspires to be:
541e1e0d 41
a9c3e753
S
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.
541e1e0d 45
a9c3e753 46[ List each incompatible change as a =head2 entry ]
541e1e0d 47
a9c3e753 48=head1 Deprecations
541e1e0d 49
a9c3e753 50XXX Any deprecated features, syntax, modules etc. should be listed here.
541e1e0d 51
a9c3e753 52=head2 Module removals
541e1e0d 53
a9c3e753 54XXX Remove this section if inapplicable.
541e1e0d 55
a9c3e753
S
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.
cd7bac54 60
a9c3e753
S
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.
541e1e0d 64
a9c3e753
S
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.
541e1e0d 69
a9c3e753 70=over
cd7bac54 71
a9c3e753 72=item XXX
6c8457e9 73
a9c3e753
S
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.
cd7bac54
S
76
77=back
6c8457e9 78
a9c3e753 79[ List each other deprecation as a =head2 entry ]
6c8457e9 80
a9c3e753 81=head1 Performance Enhancements
6c8457e9 82
a9c3e753
S
83XXX Changes which enhance performance without changing behaviour go here.
84There may well be none in a stable release.
127a7155 85
a9c3e753 86[ List each enhancement as a =item entry ]
6c8457e9 87
cd7bac54
S
88=over 4
89
90=item *
91
273e254d
KW
92The functions
93C<utf8::native_to_unicode()> and
94C<utf8::unicode_to_native()> (see L<utf8>)
95are now optimized out on ASCII platforms.
96There is now not even a minimal performance hit in writing code portable
97between ASCII and EBCDIC platforms.
cd7bac54
S
98
99=back
100
a9c3e753 101=head1 Modules and Pragmata
0939a951 102
a9c3e753
S
103XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
104go here. If Module::CoreList is updated, generate an initial draft of the
105following sections using F<Porting/corelist-perldelta.pl>. A paragraph summary
106for important changes should then be added by hand. In an ideal world,
107dual-life modules would have a F<Changes> file that could be cribbed.
c49582c3 108
a9c3e753 109[ Within each section, list entries as a =item entry ]
9024667a 110
a9c3e753 111=head2 New Modules and Pragmata
31e72f27
KW
112
113=over 4
114
115=item *
116
a9c3e753 117XXX
0ce5e53e 118
31e72f27
KW
119=back
120
a9c3e753 121=head2 Updated Modules and Pragmata
cd7bac54 122
a9c3e753 123=over 4
cd7bac54
S
124
125=item *
126
83a5d6b6
SH
127L<B> has been upgraded from version 1.56 to 1.57.
128
129=item *
130
b9c683b3
TC
131L<B::Deparse> has been upgraded from version 1.33 to 1.34.
132
133Deparse C<$#_> as that instead of as C<$#{_}>. [perl #123947]
134
135=item *
136
d210e520 137L<CPAN> has been upgraded from version 2.05 to 2.10.
79116533
SH
138
139=over 4
140
141=item *
142
143Add support for C<Cwd::getdcwd()> and introduce workaround for a misbehaviour
144seen on Strawberry Perl 5.20.1.
145
146=item *
147
148Fix C<chdir()> after building dependencies bug.
149
150=item *
151
152Introduce experimental support for plugins/hooks.
153
154=item *
155
156Integrate the App::Cpan sources.
157
158=item *
159
160Do not check recursion on optional dependencies.
161
162=item *
163
164Sanity check META.yml to contain a hash.
165L<[cpan #95271]|https://rt.cpan.org/Ticket/Display.html?id=95271>
166
167=back
0939a951 168
c0ff9143
JH
169=item *
170
fea59588
SH
171L<CPAN::Meta> has been upgraded from version 2.143240 to 2.150001.
172
173=item *
174
83a5d6b6
SH
175L<Data::Dumper> has been upgraded from version 2.157 to 2.158.
176
177=item *
178
179L<DynaLoader> has been upgraded from version 1.31 to 1.32.
180
181=item *
182
e455391f
SH
183L<Encode> has been upgraded from version 2.70 to 2.72.
184
185=item *
186
83a5d6b6
SH
187L<encoding> has been upgraded from version 2.13 to 2.14.
188
189=item *
190
191L<Getopt::Long> has been upgraded from version 2.43 to 2.45.
192
193=item *
194
195L<locale> has been upgraded from version 1.05 to 1.06.
196
197=item *
198
199L<Locale::Codes> has been upgraded from version 3.33 to 3.34.
200
201=item *
202
203L<Module::CoreList> has been reverted from version 5.20150220 to 5.20150320.
204
205=item *
206
b367c45d
SH
207L<parent> has been upgraded from version 0.228 to 0.232.
208
209No changes to installed files other than the version bump.
210
211=item *
212
83a5d6b6
SH
213L<Pod::Functions> has been upgraded from version 1.08 to 1.09.
214
215=item *
216
217L<POSIX> has been upgraded from version 1.51 to 1.52.
218
219=item *
220
221L<re> has been upgraded from version 0.31 to 0.32.
222
223=item *
224
9409f752
SH
225L<Test::Simple> has been reverted from version 1.301001_098 to 1.001014.
226
227=item *
228
03a97c81
SH
229L<Text::Balanced> has been upgraded from version 2.02 to 2.03.
230
231No changes to installed files other than the version bump.
232
233=item *
234
a790e348
SH
235L<Text::ParseWords> has been upgraded from version 3.29 to 3.30.
236
237=item *
238
15af3bc0 239L<threads> has been upgraded from version 1.96_001 to 2.01.
83a5d6b6
SH
240
241=item *
242
243L<utf8> has been upgraded from version 1.14 to 1.15.
244
245=item *
246
247L<XS::APItest> has been upgraded from version 0.70 to 0.71.
c0ff9143 248
a9c3e753 249=back
0939a951 250
a9c3e753 251=head2 Removed Modules and Pragmata
cd7bac54 252
a9c3e753 253=over 4
cd7bac54
S
254
255=item *
256
a9c3e753 257XXX
cd7bac54 258
2ff1ebfe 259=back
541e1e0d 260
cd7bac54
S
261=head1 Documentation
262
a9c3e753
S
263XXX Changes to files in F<pod/> go here. Consider grouping entries by
264file and be sure to link to the appropriate page, e.g. L<perlfunc>.
265
cd7bac54
S
266=head2 New Documentation
267
a9c3e753 268XXX Changes which create B<new> files in F<pod/> go here.
541e1e0d 269
a9c3e753 270=head3 L<XXX>
d676fe86 271
a9c3e753 272XXX Description of the purpose of the new file here
d676fe86 273
a9c3e753 274=head2 Changes to Existing Documentation
d2fff9f6 275
a9c3e753
S
276XXX Changes which significantly change existing files in F<pod/> go here.
277However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
278section.
d2fff9f6 279
83a5d6b6 280=head3 L<perldata>
e329daf3 281
cd7bac54 282=over 4
e329daf3 283
cd7bac54 284=item *
e329daf3 285
83a5d6b6
SH
286Documentation has been added regarding the special floating point values C<Inf>
287and C<NaN>.
288
289=back
290
291=head3 L<perlexperiment>
292
293=over 4
294
295=item *
296
297Removed note about C<\s> matching C<VT> now that it is no longer experimental.
298
299=item *
300
301Added note that C<use re 'strict'> has been introduced experimentally.
302
303=back
304
305=head3 L<perlpolicy>
306
307=over 4
308
309=item *
310
311The documentation of what to expect to see in future maintenance releases has
312been updated. Essentially the same types of changes will be included as before
313but with fewer changes that don't affect the installation or execution of perl.
ba31029d 314
cd7bac54
S
315=back
316
a9c3e753 317=head1 Diagnostics
cd7bac54 318
a9c3e753
S
319The following additions or changes have been made to diagnostic output,
320including warnings and fatal error messages. For the complete list of
321diagnostic messages, see L<perldiag>.
cd7bac54 322
a9c3e753
S
323XXX New or changed warnings emitted by the core's C<C> code go here. Also
324include any changes in L<perldiag> that reconcile it to the C<C> code.
cd7bac54 325
a9c3e753 326=head2 New Diagnostics
541e1e0d 327
a9c3e753
S
328XXX Newly added diagnostic messages go under here, separated into New Errors
329and New Warnings
541e1e0d 330
a9c3e753 331=head3 New Errors
cd7bac54
S
332
333=over 4
334
335=item *
336
83a5d6b6
SH
337L<Invalid quantifier in {,} in regex; marked by <-- HERE in mE<sol>%sE<sol>|perldiag/"Invalid quantifier in {,} in regex; marked by <-- HERE in m/%s/">
338
339(F) The pattern looks like a {min,max} quantifier, but the min or max could not
340be parsed as a valid number - either it has leading zeroes, or it represents
341too big a number to cope with. The S<<-- HERE> shows where in the regular
342expression the problem was discovered. See L<perlre>.
cd7bac54
S
343
344=back
541e1e0d 345
a9c3e753 346=head3 New Warnings
541e1e0d 347
2ff1ebfe 348=over 4
aa67537d 349
4c7a0d98
DD
350=item *
351
a9c3e753 352XXX L<message|perldiag/"message">
4c7a0d98 353
b5d4d3b9 354=back
4c7a0d98 355
a9c3e753 356=head2 Changes to Existing Diagnostics
a5d66edf 357
a9c3e753 358XXX Changes (i.e. rewording) of diagnostic messages go here
f348c3d8 359
cd7bac54 360=over 4
f348c3d8 361
cd7bac54 362=item *
2ff1ebfe 363
a9c3e753 364XXX Describe change here
f348c3d8 365
cd7bac54 366=back
2ff1ebfe 367
a9c3e753 368=head1 Utility Changes
f348c3d8 369
a9c3e753
S
370XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
371Most of these are built within the directory F<utils>.
4dc623f0 372
a9c3e753
S
373[ List utility changes as a =head2 entry for each utility and =item
374entries for each change
375Use L<XXX> with program names to get proper documentation linking. ]
84d03adf 376
a9c3e753 377=head2 L<XXX>
ff433f2d 378
9ce6583e 379=over 4
4cd408ba 380
9ce6583e 381=item *
6ed80d55 382
a9c3e753 383XXX
9ce6583e 384
2ff1ebfe 385=back
ab0b796c 386
a9c3e753 387=head1 Configuration and Compilation
cd7bac54 388
a9c3e753
S
389XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
390go here. Any other changes to the Perl build process should be listed here.
391However, any platform-specific changes should be listed in the
392L</Platform Support> section, instead.
cd7bac54 393
a9c3e753 394[ List changes as a =item entry ].
8c6180a9 395
2ff1ebfe 396=over 4
0561e60b 397
9ce6583e 398=item *
dd200dff 399
a9c3e753 400XXX
c877af1b 401
cd7bac54 402=back
c877af1b 403
a9c3e753 404=head1 Testing
cd7bac54 405
a9c3e753
S
406XXX Any significant changes to the testing of a freshly built perl should be
407listed here. Changes which create B<new> files in F<t/> go here as do any
408large changes to the testing harness (e.g. when parallel testing was added).
409Changes to existing files in F<t/> aren't worth summarizing, although the bugs
410that they represent may be covered elsewhere.
cd7bac54 411
a9c3e753 412[ List each test improvement as a =item entry ]
bb8c7e27 413
b5d4d3b9 414=over 4
83b69bfd
DD
415
416=item *
417
83a5d6b6 418Tests for performance issues have been added in the file F<t/perf/taint.t>.
13adb056 419
b5d4d3b9 420=back
391823f2 421
a9c3e753 422=head1 Platform Support
6c8457e9 423
a9c3e753 424XXX Any changes to platform support should be listed in the sections below.
6c8457e9 425
a9c3e753
S
426[ Within the sections, list each platform as a =item entry with specific
427changes as paragraphs below it. ]
db98db4e 428
a9c3e753 429=head2 New Platforms
8818afe8 430
a9c3e753
S
431XXX List any platforms that this version of perl compiles on, that previous
432versions did not. These will either be enabled by new files in the F<hints/>
433directories, or new subdirectories and F<README> files at the top level of the
434source tree.
8af808bf 435
2ff1ebfe 436=over 4
fdcaecb7 437
a9c3e753 438=item XXX-some-platform
fdcaecb7 439
a9c3e753 440XXX
2af7c6b6 441
4dc623f0 442=back
2af7c6b6 443
a9c3e753
S
444=head2 Discontinued Platforms
445
446XXX List any platforms that this version of perl no longer compiles on.
70cee83f 447
b5d4d3b9 448=over 4
e5fbfbc1 449
a9c3e753 450=item XXX-some-platform
b4045391 451
a9c3e753 452XXX
b4045391 453
2ff1ebfe 454=back
b4045391 455
2ff1ebfe 456=head2 Platform-Specific Notes
8c847e66 457
a9c3e753
S
458XXX List any changes for specific platforms. This could include configuration
459and compilation changes or changes in portability/compatibility. However,
460changes within modules for platforms should generally be listed in the
461L</Modules and Pragmata> section.
8c847e66 462
2ff1ebfe 463=over 4
d345f487 464
a9c3e753 465=item XXX-some-platform
d345f487 466
a9c3e753 467XXX
cd7bac54 468
4dc623f0 469=back
353075a0 470
a9c3e753 471=head1 Internal Changes
9f122eef 472
a9c3e753
S
473XXX Changes which affect the interface available to C<XS> code go here. Other
474significant internal changes for future core maintainers should be noted as
475well.
2ff1ebfe 476
a9c3e753 477[ List each change as a =item entry ]
2ff1ebfe 478
b5d4d3b9 479=over 4
2ec11c70
DM
480
481=item *
482
45235d99
KW
483Macros have been created to allow XS code to better manipulate the POSIX
484locale category C<LC_NUMERIC>.
485See L<perlapi/Locale-related functions and macros>.
2683609f 486
4dc623f0 487=back
c7f058f0 488
4dc623f0 489=head1 Selected Bug Fixes
0ef4323a 490
a9c3e753
S
491XXX Important bug fixes in the core language are summarized here. Bug fixes in
492files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
567291b6 493
a9c3e753 494[ List each fix as a =item entry ]
436f6503 495
a9c3e753 496=over 4
2bf83140 497
041a5927
FC
498=item *
499
5268e911
TC
500Repeated global pattern matches in scalar context on large tainted
501strings were exponentially slow depending on the current match
502position in the string. [perl #123202]
041a5927 503
a9c3e753 504=back
ea13b07e 505
a9c3e753 506=head1 Known Problems
b65adbec 507
a9c3e753
S
508XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
509tests that had to be C<TODO>ed for the release would be noted here. Unfixed
510platform specific bugs also go here.
b65adbec 511
a9c3e753 512[ List each fix as a =item entry ]
370c71c5 513
a9c3e753 514=over 4
b94c7836
FC
515
516=item *
517
a9c3e753 518XXX
439f6100 519
a9c3e753 520=back
e3e8f263 521
a9c3e753 522=head1 Errata From Previous Releases
cd7bac54 523
a9c3e753 524=over 4
e3e8f263 525
cb6cc22b
TC
526=item *
527
a9c3e753
S
528XXX Add anything here that we forgot to add, or were mistaken about, in
529the perldelta of a previous release.
cb6cc22b 530
b5d4d3b9 531=back
fcfb7b86 532
a9c3e753 533=head1 Obituary
cd7bac54 534
a9c3e753
S
535XXX If any significant core contributor has died, we've added a short obituary
536here.
cd7bac54 537
a9c3e753 538=head1 Acknowledgements
541e1e0d 539
a9c3e753 540XXX Generate this with:
01d42a22 541
a9c3e753 542 perl Porting/acknowledgements.pl v5.21.9..HEAD
f5b73711 543
44691e6f
AB
544=head1 Reporting Bugs
545
e08634c5
SH
546If you find what you think is a bug, you might check the articles recently
547posted to the comp.lang.perl.misc newsgroup and the perl bug database at
238894db 548https://rt.perl.org/ . There may also be information at
7ef8b31d 549http://www.perl.org/ , the Perl Home Page.
44691e6f 550
e08634c5
SH
551If you believe you have an unreported bug, please run the L<perlbug> program
552included with your release. Be sure to trim your bug down to a tiny but
553sufficient test case. Your bug report, along with the output of C<perl -V>,
554will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
555
556If the bug you are reporting has security implications, which make it
e08634c5
SH
557inappropriate to send to a publicly archived mailing list, then please send it
558to perl5-security-report@perl.org. This points to a closed subscription
559unarchived mailing list, which includes all the core committers, who will be
560able to help assess the impact of issues, figure out a resolution, and help
f9001595 561co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
562platforms on which Perl is supported. Please only use this address for
563security issues in the Perl core, not for modules independently distributed on
564CPAN.
44691e6f
AB
565
566=head1 SEE ALSO
567
e08634c5
SH
568The F<Changes> file for an explanation of how to view exhaustive details on
569what changed.
44691e6f
AB
570
571The F<INSTALL> file for how to build Perl.
572
573The F<README> file for general stuff.
574
575The F<Artistic> and F<Copying> files for copyright information.
576
577=cut