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