This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Bump Locale-Codes from 3.30 to 3.31
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
7065301c
RS
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.1
c68523cb 9
238894db 10=head1 DESCRIPTION
c68523cb 11
7065301c 12This document describes differences between the 5.21.0 release and the 5.21.1
238894db 13release.
c68523cb 14
7065301c
RS
15If you are upgrading from an earlier release such as 5.20.0, first read
16L<perl5210delta>, which describes differences between 5.20.0 and 5.21.0.
17
18=head1 Notice
19
20XXX Any important notices here
21
22=head1 Core Enhancements
23
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.
27
28[ List each enhancement as a =head2 entry ]
29
8373491a
KW
30=head2 C<qr/foo/x> now ignores any Unicode pattern white space
31
32The C</x> regular expression modifier allows the pattern to contain
33white space and comments, both of which are ignored, for improved
34readability. Until now, not all the white space characters that Unicode
35designates for this purpose were handled. The additional ones now
36recognized are
37U+0085 NEXT LINE,
38U+200E LEFT-TO-RIGHT MARK,
39U+200F RIGHT-TO-LEFT MARK,
40U+2028 LINE SEPARATOR,
41and
42U+2029 PARAGRAPH SEPARATOR.
43
7065301c
RS
44=head1 Security
45
46XXX Any security-related notices go here. In particular, any security
47vulnerabilities closed should be noted here rather than in the
48L</Selected Bug Fixes> section.
49
50[ List each security issue as a =head2 entry ]
51
52=head1 Incompatible Changes
53
54XXX For a release on a stable branch, this section aspires to be:
55
56 There are no changes intentionally incompatible with 5.XXX.XXX
57 If any exist, they are bugs, and we request that you submit a
58 report. See L</Reporting Bugs> below.
59
7357bd17
KW
60=head2 In double-quotish C<\cI<X>>, I<X> must now be a printable ASCII character
61
62In prior releases, failure to do this raised a deprecation warning.
7065301c 63
cd209d9d
KW
64=head2 Splitting the tokens C<(?> and C<(*> in regular expressions is
65now a fatal compilation error.
66
67These had been deprecated since v5.18.
68
8373491a
KW
69=head2 5 additional characters are treated as white space under C</x> in
70regex patterns (unless escaped)
71
72The use of these characters with C</x> outside bracketed character
73classes and when not preceeded by a backslash has raised a deprecation
74warning since v5.18. Now they will be ignored. See L</qrE<sol>fooE<sol>x>
75for the list of the five characters.
76
77=head2 Comment lines within S<C<(?[ ])>> now are ended only by a C<\n>
78
79S<C<(?[ ])>> is an experimental feature, introduced in v5.18. It operates
80as if C</x> is always enabled. But there was a difference, comment
81lines (following a C<#> character) were terminated by anything matching
82C<\R> which includes all vertical whitespace, such as form feeds. For
83consistency, this is now changed to match what terminates comment lines
84outside S<C<(?[ ])>>, namely a C<\n> (even if escaped), which is the
85same as what terminates a heredoc string and formats.
86
7065301c
RS
87=head1 Deprecations
88
89XXX Any deprecated features, syntax, modules etc. should be listed here.
90
df758df2
KW
91=head2 Using a NO-BREAK space in a character alias for C<\N{...}> is now
92deprecated
93
94This non-graphic character is essentially indistinguishable from a
95regular space, and so should not be allowed. See
96L<charnames/CUSTOM ALIASES>.
97
7065301c
RS
98=head2 Module removals
99
100XXX Remove this section if inapplicable.
101
102The following modules will be removed from the core distribution in a
103future release, and will at that time need to be installed from CPAN.
104Distributions on CPAN which require these modules will need to list them as
105prerequisites.
106
107The core versions of these modules will now issue C<"deprecated">-category
108warnings to alert you to this fact. To silence these deprecation warnings,
109install the modules in question from CPAN.
110
111Note that these are (with rare exceptions) fine modules that you are encouraged
112to continue to use. Their disinclusion from core primarily hinges on their
113necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
114not usually on concerns over their design.
115
116=over
117
118=item XXX
119
120XXX Note that deprecated modules should be listed here even if they are listed
121as an updated module in the L</Modules and Pragmata> section.
122
123=back
124
125[ List each other deprecation as a =head2 entry ]
126
127=head1 Performance Enhancements
128
129XXX Changes which enhance performance without changing behaviour go here.
130There may well be none in a stable release.
131
132[ List each enhancement as a =item entry ]
133
134=over 4
135
136=item *
137
138XXX
139
140=back
141
7ef8b31d 142=head1 Modules and Pragmata
f6f3144e 143
7065301c
RS
144XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
145go here. If Module::CoreList is updated, generate an initial draft of the
146following sections using F<Porting/corelist-perldelta.pl>. A paragraph summary
147for important changes should then be added by hand. In an ideal world,
148dual-life modules would have a F<Changes> file that could be cribbed.
149
150[ Within each section, list entries as a =item entry ]
151
152=head2 New Modules and Pragmata
24a38d90
RS
153
154=over 4
155
156=item *
157
7065301c
RS
158XXX
159
160=back
161
162=head2 Updated Modules and Pragmata
163
164=over 4
24a38d90
RS
165
166=item *
167
56cdf413
TC
168L<Carp> has been upgraded from version 1.3301 to 1.34.
169
170Carp::Heavy now ignores version mismatches with Carp if Carp is newer
171than 1.12, since Carp::Heavy's guts were merged into Carp at that
172point.
173L<[perl #121574]|https://rt.perl.org/Ticket/Display.html?id=121574>
174
175=item *
176
28e02325
SH
177L<Encode> has been upgraded from version 2.60_01 to 2.62.
178
179B<piconv> now has better error handling when the encoding name is nonexistent,
180and a build breakage when upgrading L<Encode> in perl-5.8.2 and earlier has
181been fixed.
182
183=item *
184
5abafd4c
SH
185The libnet collection of modules has been upgraded from version 1.25 to 1.27.
186
187There are only whitespace changes to the installed files.
188
189=item *
190
4ed8f5ed
TC
191L<Math::BigInt> has been upgraded from version 1.9993 to 1.9994.
192
193Synchronize POD changes from the CPAN release.
194
ee15bb65
TC
195C<< Math::BigFloat->blog(x) >> would sometimes return blog(2*x) when
196the accuracy was greater than 70 digits.
197
198The result of C<< Math::BigFloat->bdiv() >> in list context now
199satisfies C<< x = quotient * divisor + remainder >>.
200
4ed8f5ed
TC
201=item *
202
234105dd
TC
203L<Math::BigRat> has been upgraded from version 0.2606 to 0.2607.
204
205Synchronize POD changes from the CPAN release.
206
207=item *
208
c13fd1a2
TC
209L<perl5db.pl> has been upgraded from version 1.44 to 1.45.
210
3ca75eca
YO
211=item *
212
213A mismatch between the documentation and the code in utf8::downgrade()
214was fixed in favour of the documentation. The optional second argument
215is now correctly treated as a perl boolean (true/false semantics) and
216not as an integer.
217
218=item *
219
c13fd1a2 220fork() in the debugger under C<tmux> will now create a new window for
891822fa
TC
221the forked process. L<[perl
222#121333]|https://rt.perl.org/Ticket/Display.html?id=121333>
223
224The debugger now saves the current working directory on startup and
225restores it when you restart your program with C<R> or <rerun>. L<[perl
226#121509]|https://rt.perl.org/Ticket/Display.html?id=121509>
24a38d90 227
f8187d97
SH
228L<Unicode::Collate> has been upgraded from version 1.04 to 1.07.
229
230Version 0.67's improved discontiguous contractions is invalidated by default
231and is supported as a parameter 'long_contraction'.
232
95f3e8d2
SH
233=item *
234
235L<Unicode::Normalize> has been upgraded from version 1.17 to 1.18.
236
237The XSUB implementation has been removed in favour of pure Perl.
238
3eaa3d14
YO
239=item *
240
241L<Hash::Util> has been upgraded from version 0.16 to 0.17.
242
243Minor bug fixes and documentation fixes to Hash::Util::hash_stats()
244
245
238894db 246=back
24a38d90 247
92fa985e 248=head2 Removed Modules and Pragmata
24a38d90 249
238894db 250=over 4
24a38d90
RS
251
252=item *
253
7065301c
RS
254XXX
255
256=back
257
258=head1 Documentation
259
260XXX Changes to files in F<pod/> go here. Consider grouping entries by
261file and be sure to link to the appropriate page, e.g. L<perlfunc>.
262
263=head2 New Documentation
264
265XXX Changes which create B<new> files in F<pod/> go here.
266
267=head3 L<XXX>
268
269XXX Description of the purpose of the new file here
270
271=head2 Changes to Existing Documentation
272
273XXX Changes which significantly change existing files in F<pod/> go here.
274However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
275section.
276
277=head3 L<XXX>
278
279=over 4
280
281=item *
282
283XXX Description of the change here
284
285=back
286
287=head1 Diagnostics
288
289The following additions or changes have been made to diagnostic output,
290including warnings and fatal error messages. For the complete list of
291diagnostic messages, see L<perldiag>.
292
293XXX New or changed warnings emitted by the core's C<C> code go here. Also
294include any changes in L<perldiag> that reconcile it to the C<C> code.
295
296=head2 New Diagnostics
297
298XXX Newly added diagnostic messages go under here, separated into New Errors
299and New Warnings
300
301=head3 New Errors
302
303=over 4
24a38d90
RS
304
305=item *
306
7065301c
RS
307XXX L<message|perldiag/"message">
308
309=back
310
311=head3 New Warnings
312
313=over 4
24a38d90
RS
314
315=item *
316
7065301c 317XXX L<message|perldiag/"message">
24a38d90 318
238894db 319=back
24a38d90 320
7065301c 321=head2 Changes to Existing Diagnostics
24a38d90 322
7065301c 323XXX Changes (i.e. rewording) of diagnostic messages go here
24a38d90 324
7065301c
RS
325=over 4
326
327=item *
328
723edb96
TC
329L<Unsuccessful %s on filename containing newline|perldiag/"Unsuccessful %s on filename containing newline">
330
331This warning is now only produced when the newline is at the end of
332the filename.
7065301c
RS
333
334=back
335
336=head1 Utility Changes
337
338XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
339Most of these are built within the directories F<utils> and F<x2p>.
340
341[ List utility changes as a =head2 entry for each utility and =item
342entries for each change
343Use L<XXX> with program names to get proper documentation linking. ]
344
345=head2 L<XXX>
346
347=over 4
348
349=item *
24a38d90 350
7065301c
RS
351XXX
352
353=back
354
355=head1 Configuration and Compilation
356
357XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
358go here. Any other changes to the Perl build process should be listed here.
359However, any platform-specific changes should be listed in the
360L</Platform Support> section, instead.
361
362[ List changes as a =item entry ].
363
364=over 4
365
366=item *
367
368XXX
369
370=back
371
372=head1 Testing
373
374XXX Any significant changes to the testing of a freshly built perl should be
375listed here. Changes which create B<new> files in F<t/> go here as do any
376large changes to the testing harness (e.g. when parallel testing was added).
377Changes to existing files in F<t/> aren't worth summarizing, although the bugs
378that they represent may be covered elsewhere.
379
380[ List each test improvement as a =item entry ]
381
382=over 4
383
384=item *
385
386XXX
387
388=back
389
390=head1 Platform Support
391
392XXX Any changes to platform support should be listed in the sections below.
393
394[ Within the sections, list each platform as a =item entry with specific
395changes as paragraphs below it. ]
396
397=head2 New Platforms
398
399XXX List any platforms that this version of perl compiles on, that previous
400versions did not. These will either be enabled by new files in the F<hints/>
401directories, or new subdirectories and F<README> files at the top level of the
402source tree.
403
404=over 4
405
406=item XXX-some-platform
407
408XXX
409
410=back
411
412=head2 Discontinued Platforms
413
414XXX List any platforms that this version of perl no longer compiles on.
415
416=over 4
417
418=item XXX-some-platform
419
420XXX
421
422=back
423
424=head2 Platform-Specific Notes
425
426XXX List any changes for specific platforms. This could include configuration
427and compilation changes or changes in portability/compatibility. However,
428changes within modules for platforms should generally be listed in the
429L</Modules and Pragmata> section.
430
431=over 4
432
433=item XXX-some-platform
434
435XXX
436
437=back
438
439=head1 Internal Changes
440
441XXX Changes which affect the interface available to C<XS> code go here. Other
442significant internal changes for future core maintainers should be noted as
443well.
444
7065301c
RS
445=over 4
446
447=item *
448
8dab3ba5 449The deprecated variable C<PL_sv_objcount> has been removed.
7065301c
RS
450
451=back
452
453=head1 Selected Bug Fixes
454
455XXX Important bug fixes in the core language are summarized here. Bug fixes in
456files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
457
458[ List each fix as a =item entry ]
459
460=over 4
461
462=item *
463
30536d4a
TC
464index() and rindex() no longer crash when used on strings over 2GB in
465size.
466L<[perl #121562]|https://rt.perl.org/Ticket/Display.html?id=121562>.
7065301c 467
0c2c57a8
DD
468=item *
469
470A small previously intentional memory leak in PERL_SYS_INIT/PERL_SYS_INIT3 on
471Win32 builds was fixed. This might affect embedders who repeatedly create and
472destroy perl engines within the same process.
473
7065301c
RS
474=back
475
476=head1 Known Problems
477
478XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
479tests that had to be C<TODO>ed for the release would be noted here. Unfixed
480platform specific bugs also go here.
481
482[ List each fix as a =item entry ]
483
484=over 4
485
486=item *
487
488XXX
489
490=back
491
492=head1 Errata From Previous Releases
493
494=over 4
495
496=item *
497
498XXX Add anything here that we forgot to add, or were mistaken about, in
499the perldelta of a previous release.
500
501=back
502
503=head1 Obituary
504
505XXX If any significant core contributor has died, we've added a short obituary
506here.
507
508=head1 Acknowledgements
24a38d90 509
7065301c 510XXX Generate this with:
52e02e68 511
7065301c 512 perl Porting/acknowledgements.pl v5.21.1..HEAD
f5b73711 513
44691e6f
AB
514=head1 Reporting Bugs
515
e08634c5
SH
516If you find what you think is a bug, you might check the articles recently
517posted to the comp.lang.perl.misc newsgroup and the perl bug database at
238894db 518https://rt.perl.org/ . There may also be information at
7ef8b31d 519http://www.perl.org/ , the Perl Home Page.
44691e6f 520
e08634c5
SH
521If you believe you have an unreported bug, please run the L<perlbug> program
522included with your release. Be sure to trim your bug down to a tiny but
523sufficient test case. Your bug report, along with the output of C<perl -V>,
524will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
525
526If the bug you are reporting has security implications, which make it
e08634c5
SH
527inappropriate to send to a publicly archived mailing list, then please send it
528to perl5-security-report@perl.org. This points to a closed subscription
529unarchived mailing list, which includes all the core committers, who will be
530able to help assess the impact of issues, figure out a resolution, and help
f9001595 531co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
532platforms on which Perl is supported. Please only use this address for
533security issues in the Perl core, not for modules independently distributed on
534CPAN.
44691e6f
AB
535
536=head1 SEE ALSO
537
e08634c5
SH
538The F<Changes> file for an explanation of how to view exhaustive details on
539what changed.
44691e6f
AB
540
541The F<INSTALL> file for how to build Perl.
542
543The F<README> file for general stuff.
544
545The F<Artistic> and F<Copying> files for copyright information.
546
547=cut