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