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