This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
397532b1d3521233a8d644908865aa5ba075fb5a
[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.25.9
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.25.8 release and the 5.25.9
13 release.
14
15 If you are upgrading from an earlier release such as 5.25.7, first read
16 L<perl5258delta>, which describes differences between 5.25.7 and 5.25.8.
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 =head2 New regular expression modifier C</xx>
29
30 Specifying two C<x> characters to modify a regular expression pattern
31 does everything that a single one does, but additionally TAB and SPACE
32 characters within a bracketed character class are generally ignored and
33 can be added to improve readability, like
34 S<C</[ ^ A-Z d-f p-x ]/xx>>.  Details are at
35 L<perlre/E<sol>x and E<sol>xx>.
36
37 =head1 Security
38
39 XXX Any security-related notices go here.  In particular, any security
40 vulnerabilities closed should be noted here rather than in the
41 L</Selected Bug Fixes> section.
42
43 [ List each security issue as a =head2 entry ]
44
45 =head1 Incompatible Changes
46
47 XXX For a release on a stable branch, this section aspires to be:
48
49     There are no changes intentionally incompatible with 5.XXX.XXX
50     If any exist, they are bugs, and we request that you submit a
51     report.  See L</Reporting Bugs> below.
52
53 [ List each incompatible change as a =head2 entry ]
54
55 =head1 Deprecations
56
57 =head2 String delimiters that aren't stand-alone graphemes are now
58 deprecated
59
60 In order for Perl to eventually allow string delimiters to be Unicode
61 grapheme clusters (which look like a single character, but may be
62 a sequence of several ones), we have to stop allowing a single char
63 delimiter that isn't a grapheme by itself.  These are unlikely to exist
64 in actual code, as they would typically display as attached to the
65 character in front of them.
66
67 =head2 Module removals
68
69 XXX Remove this section if inapplicable.
70
71 The following modules will be removed from the core distribution in a
72 future release, and will at that time need to be installed from CPAN.
73 Distributions on CPAN which require these modules will need to list them as
74 prerequisites.
75
76 The core versions of these modules will now issue C<"deprecated">-category
77 warnings to alert you to this fact.  To silence these deprecation warnings,
78 install the modules in question from CPAN.
79
80 Note that these are (with rare exceptions) fine modules that you are encouraged
81 to continue to use.  Their disinclusion from core primarily hinges on their
82 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
83 not usually on concerns over their design.
84
85 =over
86
87 =item XXX
88
89 XXX Note that deprecated modules should be listed here even if they are listed
90 as an updated module in the L</Modules and Pragmata> section.
91
92 =back
93
94 [ List each other deprecation as a =head2 entry ]
95
96 =head1 Performance Enhancements
97
98 XXX Changes which enhance performance without changing behaviour go here.
99 There may well be none in a stable release.
100
101 [ List each enhancement as a =item entry ]
102
103 =over 4
104
105 =item *
106
107 XXX
108
109 =back
110
111 =head1 Modules and Pragmata
112
113 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
114 go here.  If Module::CoreList is updated, generate an initial draft of the
115 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
116 for important changes should then be added by hand.  In an ideal world,
117 dual-life modules would have a F<Changes> file that could be cribbed.
118
119 [ Within each section, list entries as a =item entry ]
120
121 =head2 New Modules and Pragmata
122
123 =over 4
124
125 =item *
126
127 XXX
128
129 =back
130
131 =head2 Updated Modules and Pragmata
132
133 =over 4
134
135 =item *
136
137 L<XXX> has been upgraded from version A.xx to B.yy.
138
139 =item *
140
141 L<re> has been upgraded from version 0.33 to 0.34;
142
143 This adds support for the new L<C</xx>|perlre/E<sol>x and E<sol>xx>
144 regular expression pattern modifier, and a change to the L<S<C<use re
145 'strict'>>|re/'strict' mode> experimental feature.  When S<C<re
146 'strict'>> is enabled, a warning now will be generated for all
147 unescaped uses of the two characters C<}> and C<]> in regular
148 expression patterns (outside bracketed character classes) that are taken
149 literally.  This brings them more in line with the C<)> character which
150 is always a metacharacter unless escaped.  Being a metacharacter only
151 sometimes, depending on action at a distance, can lead to silently
152 having the pattern mean something quite different than was intended,
153 which the S<C<re 'strict'>> mode is intended to minimize.
154
155 =item *
156
157 L<B::Xref> has been upgraded from version 1.05 to 1.06.
158
159 =item *
160
161 L<Compress::Raw::Bzip2> has been upgraded from version 2.069 to 2.070.
162
163 =item *
164
165 L<Compress::Raw::Zlib> has been upgraded from version 2.069 to 2.070.
166
167 =item *
168
169 L<DB_File> has been upgraded from version 1.838 to 1.840.
170
171 =item *
172
173 L<Devel::SelfStubber> has been upgraded from version 1.05 to 1.06.
174
175 =item *
176
177 L<diagnostics> has been upgraded from version 1.35 to 1.36.
178
179 =item *
180
181 L<DynaLoader> has been upgraded from version 1.40 to 1.41.
182
183 =item *
184
185 L<Errno> has been upgraded from version 1.27 to 1.28.
186
187 =item *
188
189 L<ExtUtils::Embed> has been upgraded from version 1.33 to 1.34.
190
191 =item *
192
193 L<I18N::LangTags> has been upgraded from version 0.41 to 0.42.
194
195 =item *
196
197 L<lib> has been upgraded from version 0.63 to 0.64.
198
199 =item *
200
201 L<Module::CoreList> has been upgraded from version 5.20161220 to 5.20170120.
202
203 =item *
204
205 L<OS2::Process> has been upgraded from version 1.11 to 1.12.
206
207 =item *
208
209 L<perl5db.pl> has been upgraded from version 1.50 to 1.51.
210
211 =item *
212
213 L<Storable> has been upgraded from version 2.59 to 2.61.
214
215 =item *
216
217 L<Symbol> has been upgraded from version 1.07 to 1.08.
218
219 =item *
220
221 L<Term::ReadLine> has been upgraded from version 1.15 to 1.16.
222
223 =item *
224
225 L<Test> has been upgraded from version 1.29 to 1.30.
226
227 =item *
228
229 L<threads::shared> has been upgraded from version 1.52 to 1.53.
230
231 =item *
232
233 L<Unicode::UCD> has been upgraded from version 0.67 to 0.68.
234
235 =item *
236
237 L<VMS::DCLsym> has been upgraded from version 1.07 to 1.08.
238
239 =item *
240
241 L<XSLoader> has been upgraded from version 0.24 to 0.26.
242
243 =back
244
245 =head2 Removed Modules and Pragmata
246
247 =over 4
248
249 =item *
250
251 XXX
252
253 =back
254
255 =head1 Documentation
256
257 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
258 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
259
260 =head2 New Documentation
261
262 XXX Changes which create B<new> files in F<pod/> go here.
263
264 =head3 L<XXX>
265
266 XXX Description of the purpose of the new file here
267
268 =head2 Changes to Existing Documentation
269
270 XXX Changes which significantly change existing files in F<pod/> go here.
271 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
272 section.
273
274 =head3 L<XXX>
275
276 =over 4
277
278 =item *
279
280 XXX Description of the change here
281
282 =back
283
284 =head1 Diagnostics
285
286 The following additions or changes have been made to diagnostic output,
287 including warnings and fatal error messages.  For the complete list of
288 diagnostic messages, see L<perldiag>.
289
290 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
291 include any changes in L<perldiag> that reconcile it to the C<C> code.
292
293 =head2 New Diagnostics
294
295 XXX Newly added diagnostic messages go under here, separated into New Errors
296 and New Warnings
297
298 =head3 New Errors
299
300 =over 4
301
302 =item *
303
304 XXX L<message|perldiag/"message">
305
306 =back
307
308 =head3 New Warnings
309
310 =over 4
311
312 =item *
313
314 XXX L<message|perldiag/"message">
315
316 =back
317
318 =head2 Changes to Existing Diagnostics
319
320 As of Perl 5.25.9, all new deprecations will come with a version in
321 which the feature will disappear. And with a few exceptions, most
322 existing deprecations will state when they'll disappear. As such, most
323 deprecation messages have changed.
324
325 =over 4
326
327 =item *
328
329 Attribute "locked" is deprecated, and will disappear in Perl 5.28
330
331 =item *
332
333 Attribute "unique" is deprecated, and will disappear in Perl 5.28
334
335 =item *
336
337 "\c%c" is more clearly written simply as "%s". This will be a fatal error
338 in Perl 5.28
339
340 =item *
341
342 Constants from lexical variables potentially modified elsewhere are
343 deprecated. This will not be allowed in Perl 5.32
344
345 =item *
346
347 Deprecated use of my() in false conditional. This will be a fatal error
348 in Perl 5.30
349
350 =item *
351
352 dump() better written as CORE::dump(). dump() will no longer be available 
353 in Perl 5.30
354
355 =item *
356
357 ${^ENCODING} is no longer supported. Its use will be fatal in Perl 5.28
358
359 =item *
360
361 File::Glob::glob() will disappear in perl 5.30. Use File::Glob::bsd_glob()
362 instead.
363
364 =item *
365
366 %s() is deprecated on :utf8 handles. This will be a fatal error in Perl 5.30
367
368 =item *
369
370 $* is no longer supported. Its use will be fatal in Perl 5.30
371
372 =item *
373
374 $* is no longer supported. Its use will be fatal in Perl 5.30
375
376 =item *
377
378 Opening dirhandle %s also as a file. This will be a fatal error in Perl 5.28
379
380 =item *
381
382 Opening filehandle %s also as a directory. This will be a fatal
383 error in Perl 5.28
384
385 =item *
386
387 Setting $/ to a reference to %s as a form of slurp is deprecated,
388 treating as undef. This will be fatal in Perl 5.28
389
390 =item *
391
392 Unescaped left brace in regex is deprecated here (and will be fatal
393 in Perl 5.30), passed through in regex; marked by S<<-- HERE> in m/%s/
394
395 =item *
396
397 Unknown charname '' is deprecated. Its use will be fatal in Perl 5.28
398
399 =item *
400
401 Use of bare << to mean <<"" is deprecated. Its use will be fatal in Perl 5.28
402
403 =item *
404
405 Use of code point 0x%s is deprecated; the permissible max is 0x%s.
406 This will be fatal in Perl 5.28
407
408 =item *
409
410 Use of comma-less variable list is deprecated. Its use will be fatal
411 in Perl 5.28
412
413 =item *
414
415 Use of inherited AUTOLOAD for non-method %s() is deprecated. This
416 will be fatal in Perl 5.28
417
418 =item * 
419
420 Use of strings with code points over 0xFF as arguments to %s operator
421 is deprecated. This will be a fatal error in Perl 5.28
422
423 =back
424
425 =head1 Utility Changes
426
427 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
428 Most of these are built within the directory F<utils>.
429
430 [ List utility changes as a =head2 entry for each utility and =item
431 entries for each change
432 Use L<XXX> with program names to get proper documentation linking. ]
433
434 =head2 L<XXX>
435
436 =over 4
437
438 =item *
439
440 XXX
441
442 =back
443
444 =head1 Configuration and Compilation
445
446 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
447 go here.  Any other changes to the Perl build process should be listed here.
448 However, any platform-specific changes should be listed in the
449 L</Platform Support> section, instead.
450
451 [ List changes as a =item entry ].
452
453 =over 4
454
455 =item *
456
457 The C<dtrace> build process has further changes:
458
459 =over
460
461 =item *
462
463 If the C<-xnolibs> is available, use that so a F<dtrace> perl can be
464 built within a FreeBSD jail.
465
466 =item *
467
468 On systems that build a dtrace object file (FreeBSD, Solaris and
469 SystemTap's dtrace emulation), copy the input objects to a separate
470 directory and process them there, and use those objects in the link,
471 since C<dtrace -G> also modifies these objects.
472
473 =item *
474
475 Add libelf to the build on FreeBSD 10.x, since dtrace adds references
476 to libelf symbols.
477
478 =item *
479
480 Generate a dummy dtrace_main.o if C<dtrace -G> fails to build it.  A
481 default build on Solaris generates probes from the unused inline
482 functions, while they don't on FreeBSD, which causes C<dtrace -G> to
483 fail.
484
485 =back
486
487 [perl #130108]
488
489 =item *
490
491 You can now disable perl's use of the PERL_HASH_SEED and
492 PERL_PERTURB_KEYS environment variables by configureing perl with
493 C<-Accflags=NO_PERL_HASH_ENV>.
494
495 =item *
496
497 You can now disable perl's use of the PERL_HASH_SEED_DEBUG environment
498 variable by configuring perl with
499 C<-Accflags=-DNO_PERL_HASH_SEED_DEBUG>.
500
501 =back
502
503 =head1 Testing
504
505 XXX Any significant changes to the testing of a freshly built perl should be
506 listed here.  Changes which create B<new> files in F<t/> go here as do any
507 large changes to the testing harness (e.g. when parallel testing was added).
508 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
509 that they represent may be covered elsewhere.
510
511 [ List each test improvement as a =item entry ]
512
513 =over 4
514
515 =item *
516
517 XXX
518
519 =back
520
521 =head1 Platform Support
522
523 XXX Any changes to platform support should be listed in the sections below.
524
525 [ Within the sections, list each platform as a =item entry with specific
526 changes as paragraphs below it. ]
527
528 =head2 New Platforms
529
530 XXX List any platforms that this version of perl compiles on, that previous
531 versions did not.  These will either be enabled by new files in the F<hints/>
532 directories, or new subdirectories and F<README> files at the top level of the
533 source tree.
534
535 =over 4
536
537 =item XXX-some-platform
538
539 XXX
540
541 =back
542
543 =head2 Discontinued Platforms
544
545 XXX List any platforms that this version of perl no longer compiles on.
546
547 =over 4
548
549 =item XXX-some-platform
550
551 XXX
552
553 =back
554
555 =head2 Platform-Specific Notes
556
557 XXX List any changes for specific platforms.  This could include configuration
558 and compilation changes or changes in portability/compatibility.  However,
559 changes within modules for platforms should generally be listed in the
560 L</Modules and Pragmata> section.
561
562 =over 4
563
564 =item XXX-some-platform
565
566 XXX
567
568 =back
569
570 =head1 Internal Changes
571
572 XXX Changes which affect the interface available to C<XS> code go here.  Other
573 significant internal changes for future core maintainers should be noted as
574 well.
575
576 [ List each change as a =item entry ]
577
578 =over 4
579
580 =item *
581
582 New versions of macros like C<isALPHA_utf8> and C<toLOWER_utf8>  have
583 been added, each with the
584 suffix C<_safe>, like C<isSPACE_utf8_safe>.  These take an extra
585 parameter, giving an upper limit of how far into the string it is safe
586 to read.  Using the old versions could cause attempts to read beyond the
587 end of the input buffer if the UTF-8 is not well-formed, and ther use
588 now raises a deprecation warning.  Details are at
589 L<perlapi/Character classification>.
590
591 =item *
592
593 Calling macros like C<isALPHA_utf8> on malformed UTF-8 have issued a
594 deprecation warning since Perl v5.18.  They now die.
595 Similarly, macros like C<toLOWER_utf8> on malformed UTF-8 now die.
596
597 =item *
598
599 Calling the functions C<utf8n_to_uvchr> and its derivatives, while
600 passing a string length of 0 is now asserted against in DEBUGGING
601 builds, and otherwise returns the Unicode REPLACEMENT CHARACTER.   If
602 you have nothing to decode, you shouldn't call the decode function.
603
604 =item *
605
606 The functions C<utf8n_to_uvchr> and its derivatives now return the
607 Unicode REPLACEMENT CHARACTER if called with UTF-8 that has the overlong
608 malformation, and that malformation is allowed by the input parameters.
609 This malformation is where the UTF-8 looks valid syntactically, but
610 there is a shorter sequence that yields the same code point.  This has
611 been forbidden since Unicode version 3.1.
612
613 =item *
614
615 The functions C<utf8n_to_uvchr> and its derivatives now accept an input
616 flag to allow the overflow malformation.  This malformation is when the
617 UTF-8 may be syntactically valid, but the code point it represents is
618 not capable of being represented in the word length on the platform.
619 What "allowed" means in this case is that the function doesn't return an
620 error, and advances the parse pointer to beyond the UTF-8 in question,
621 but it returns the Unicode REPLACEMENT CHARACTER as the value of the
622 code point (since the real value is not representable).
623
624 =back
625
626 =head1 Selected Bug Fixes
627
628 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
629 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
630
631 [ List each fix as a =item entry ]
632
633 =over 4
634
635 =item *
636
637 Under C<use utf8>, the entire Perl program is now checked that the UTF-8
638 is wellformed.  This resolves [perl #126310].
639
640 =item *
641
642 The range operator C<..> on strings now handles its arguments correctly when in
643 the scope of the L<< C<unicode_strings>|feature/"The 'unicode_strings' feature" >>
644 feature. The previous behaviour was sufficiently unexpected that we believe no
645 correct program could have made use of it.
646
647 =item *
648
649 The S<split> operator did not ensure enough space was allocated for
650 its return value in scalar context.  It could then write a single
651 pointer immediately beyond the end of the memory block allocated for
652 the stack.  [perl #130262]
653
654 =back
655
656 =head1 Known Problems
657
658 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
659 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
660 platform specific bugs also go here.
661
662 [ List each fix as a =item entry ]
663
664 =over 4
665
666 =item *
667
668 XXX
669
670 =back
671
672 =head1 Errata From Previous Releases
673
674 =over 4
675
676 =item *
677
678 XXX Add anything here that we forgot to add, or were mistaken about, in
679 the perldelta of a previous release.
680
681 =back
682
683 =head1 Obituary
684
685 XXX If any significant core contributor has died, we've added a short obituary
686 here.
687
688 =head1 Acknowledgements
689
690 XXX Generate this with:
691
692   perl Porting/acknowledgements.pl v5.25.5..HEAD
693
694 =head1 Reporting Bugs
695
696 If you find what you think is a bug, you might check the perl bug database
697 at L<https://rt.perl.org/> .  There may also be information at
698 L<http://www.perl.org/> , the Perl Home Page.
699
700 If you believe you have an unreported bug, please run the L<perlbug> program
701 included with your release.  Be sure to trim your bug down to a tiny but
702 sufficient test case.  Your bug report, along with the output of C<perl -V>,
703 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
704
705 If the bug you are reporting has security implications which make it
706 inappropriate to send to a publicly archived mailing list, then see
707 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
708 for details of how to report the issue.
709
710 =head1 SEE ALSO
711
712 The F<Changes> file for an explanation of how to view exhaustive details on
713 what changed.
714
715 The F<INSTALL> file for how to build Perl.
716
717 The F<README> file for general stuff.
718
719 The F<Artistic> and F<Copying> files for copyright information.
720
721 =cut