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