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