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