This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
f0ae6262047874a0097759680288e35ffe910ef6
[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.17.3
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.17.2 release and the 5.17.3
13 release.
14
15 If you are upgrading from an earlier release such as 5.17.1, first read
16 L<perl5172delta>, which describes differences between 5.17.1 and 5.17.2.
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 Computed Labels
31
32 The loop controls C<next>, C<last> and C<redo>, and the special C<dump>
33 operator, now allow arbitrary expressions to be used to compute labels at run
34 time.  Previously, any argument that was not a constant was treated as the
35 empty string.
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 [ List each incompatible change as a =head2 entry ]
48
49 =head2 C<$ENV{foo}=undef> deletes value from environ, like C<delete $ENV{foo}>
50
51 This facilitates use of C<local()> with C<%ENV> entries.  In previous versions
52 of Perl, C<undef> was converted to the empty string.
53
54 =head2 Defined values stored in environment are forced to byte strings
55
56 A value stored in an environment variable has always been stringified.  In this
57 release, it is converted to be only a byte string.  First, it is forced to be a
58 only a string.  Then if the string is utf8 and the equivalent of
59 C<utf8::downgrade()> works, that result is used; otherwise, the equivalent of
60 C<utf8::encode()> is used, and a warning is issued about wide characters
61 (L</Diagnostics>).
62
63 =head2 C<given> now aliases the global C<$_>
64
65 Instead of assigning to an implicit lexical C<$_>, C<given> now makes the
66 global C<$_> an alias for its argument, just like C<foreach>.  However, it
67 still uses lexical C<$_> if there is lexical C<$_> in scope (again, just like
68 C<foreach>) [perl #114020].
69
70 =head1 Deprecations
71
72 XXX Any deprecated features, syntax, modules etc. should be listed here.  In
73 particular, deprecated modules should be listed here even if they are listed as
74 an updated module in the L</Modules and Pragmata> section.
75
76 [ List each deprecation as a =head2 entry ]
77
78 =head1 Performance Enhancements
79
80 XXX Changes which enhance performance without changing behaviour go here.
81 There may well be none in a stable release.
82
83 [ List each enhancement as a =item entry ]
84
85 =over 4
86
87 =item *
88
89 XXX
90
91 =back
92
93 =head1 Modules and Pragmata
94
95 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
96 go here.  If Module::CoreList is updated, generate an initial draft of the
97 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
98 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
99 below.  A paragraph summary for important changes should then be added by hand.
100 In an ideal world, dual-life modules would have a F<Changes> file that could be
101 cribbed.
102
103 [ Within each section, list entries as a =item entry ]
104
105 =head2 New Modules and Pragmata
106
107 =over 4
108
109 =item *
110
111 XXX
112
113 =back
114
115 =head2 Updated Modules and Pragmata
116
117 =over 4
118
119 =item *
120
121 L<B> has been upgraded from version 1.36 to 1.37.  All C<CVf_*> and C<GVf_*>
122 and more SV-related flag values are now provided as constants in the C<B::>
123 namespace and available for export.  The default export list has not changed.
124
125 =item *
126
127 L<B::Concise> has been upgraded from version 0.91 to 0.92.  The C<-nobanner>
128 option has been fixed, and C<format>s can now be dumped.  When passed a sub
129 name to dump, it will check also to see whether it is the name of a format.  If
130 a sub and a format share the same name, it will dump both.
131
132 =item *
133
134 L<B::Deparse> has been upgraded from version 1.15 to 1.16.  It now deparses
135 loop controls with the correct precedence, and multiple statements in a
136 C<format> line are also now deparsed correctly.
137
138 =item *
139
140 L<CGI> has been upgraded from version 3.59 to 3.60.  Unrecognized HTML escape
141 sequences are now handled better, problematic trailing newlines are no longer
142 inserted after E<lt>formE<gt> tags by C<startform()> or C<start_form()>, and
143 bogus "Insecure Dependency" warnings appearing with some versions of perl are
144 now worked around.
145
146 =item *
147
148 L<Compress::Raw::Bzip2> has been upgraded from version 2.05201 to 2.055.  The
149 misuse of Perl's "magic" API has been fixed.
150
151 =item *
152
153 L<Compress::Raw::Zlib> has been upgraded from version 2.05401 to 2.056.  The
154 misuse of Perl's "magic" API has been fixed.
155
156 =item *
157
158 L<Compress::Zlib> has been upgraded from version 2.052 to 2.055.
159 C<compress()>, C<uncompress()>, C<memGzip()> and C<memGunzip()> have been
160 speeded up by making parameter validation more efficient.
161
162 =item *
163
164 L<Data::Dumper> has been upgraded from version 2.135_06 to 2.135_07.  It has
165 been optimized to only build a seen-scalar hash as necessary, thereby speeding
166 up serialization drastically.
167
168 =item *
169
170 L<Devel::Peek> has been upgraded from version 1.08 to 1.09.  The only change
171 has been to the test script, to account for changes to some flags in perl's
172 internals.
173
174 =item *
175
176 L<Encode> has been upgraded from version 2.44 to 2.47.  The Mac alias x-mac-ce
177 has been added, and various bugs have been fixed in Encode::Unicode,
178 Encode::UTF7 and Encode::GSM0338.
179
180 =item *
181
182 L<Module::Build> has been upgraded from version 0.40 to 0.4002.  A minor bug
183 fix allows markup to be used around the leading "Name" in a POD "abstract"
184 line, and some documentation improvements have been made.
185
186 =item *
187
188 L<Module::CoreList> has been upgraded from version 2.69 to 2.70.  Version
189 information is now stored as a delta, which greatly reduces the size of the
190 F<CoreList.pm> file.
191
192 =item *
193
194 L<Module::Load::Conditional> has been upgraded from version 0.50 to 0.54.
195 Various enhancements include the new use of Module::Metadata.
196
197 =item *
198
199 L<Module::Metadata> has been upgraded from version 1.000009 to 1.000010.  The
200 creation of a Module::Metadata object for a typical module file has been sped
201 up by about 40%.
202
203 =item *
204
205 L<Module::Pluggable> has been upgraded from version 4.0 to 4.3.  Amongst other
206 changes, triggers are now allowed on events, which gives a powerful way to
207 modify behaviour.
208
209 =item *
210
211 L<perlfaq> has been upgraded from version 5.0150040 to 5.0150041.  This
212 contains a couple of minor corrections and lists one new editor.
213
214 =item *
215
216 L<Pod::Simple> has been upgraded from version 3.20 to 3.23.  Numerous
217 improvements have been made, mostly to Pod::Simple::XHTML, which also has a
218 compatibility change: the C<codes_in_verbatim> option is now disabled by
219 default.  See F<cpan/Pod-Simple/ChangeLog> for the full details.
220
221 =item *
222
223 L<re> has been upgraded from version 0.21 to 0.22.  Single character [class]es
224 like C</[s]/> or C</[s]/i> are now optimized as if they did not have the
225 brackets, i.e. C</s/> or C</s/i>.
226
227 =item *
228
229 L<Socket> has been upgraded from version 2.002 to 2.004.  Constants and
230 functions required for IP multicast source group membership have been added.
231
232 =item *
233
234 L<Storable> has been upgraded from version 2.37 to 2.38.  It can now freeze and
235 thaw vstrings correctly.  This causes a slight incompatible change in the
236 storage format, so the format version has increased to 2.9.
237
238 =item *
239
240 L<Sys::Syslog> has been upgraded from version 0.29 to 0.30.  An issue with
241 C<POSIX::strftime()> on Windows and a build problem on Haiku-OS have been
242 resolved, and <getservbyname()> is no longer called when the port is specified.
243
244 =item *
245
246 L<Time::Local> has been upgraded from version 1.2000 to 1.2300.  Seconds values
247 greater than 59 but less than 60 no longer cause C<timegm()> and C<timelocal()>
248 to croak.
249
250 =item *
251
252 L<Unicode::UCD> has been upgraded from version 0.44 to 0.45.  This has been
253 modified slightly for reasons of perl internal use only.
254
255 =item *
256
257 L<Win32> has been upgraded from version 0.44 to 0.45.  New APIs have been added
258 for getting and setting the current code page.
259
260 =item *
261
262 L<Win32CORE> has been upgraded from version 0.02 to 0.03.  The use of
263 PERL_NO_GET_CONTEXT here has resulted in smaller machine code.
264
265 =back
266
267 =head1 Documentation
268
269 XXX Changes to files in F<pod/> go here.  Consider grouping entries by file and
270 be sure to link to the appropriate page, e.g. L<perlfunc>.
271
272 =head2 New Documentation
273
274 XXX Changes which create B<new> files in F<pod/> go here.
275
276 =head3 L<XXX>
277
278 XXX Description of the purpose of the new file here
279
280 =head2 Changes to Existing Documentation
281
282 XXX Changes which significantly change existing files in F<pod/> go here.
283 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
284 section.
285
286 =head3 L<perlfunc>, L<perlop>
287
288 =over 4
289
290 =item *
291
292 Loop control verbs (C<dump>, C<goto>, C<next>, C<last> and C<redo>) have always
293 had the same precedence as assignment operators, but this was not documented
294 until now.
295
296 =back
297
298 =head3 L<perlvar>
299
300 =over 4
301
302 =item *
303
304 A caveat has been added to the documentation for C<$_> warning against the use
305 of lexical C<$_> [perl #114020].
306
307 =back
308
309 =head1 Diagnostics
310
311 The following additions or changes have been made to diagnostic output,
312 including warnings and fatal error messages.  For the complete list of
313 diagnostic messages, see L<perldiag>.
314
315 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
316 include any changes in L<perldiag> that reconcile it to the C<C> code.
317
318 =head2 New Diagnostics
319
320 XXX Newly added diagnostic messages go under here, separated into New Errors
321 and New Warnings
322
323 =head3 New Errors
324
325 =over 4
326
327 =item *
328
329 L<Unterminated delimiter for here document|perldiag/"Unterminated delimiter for here document">
330
331 This message now occurs when a here document label has an initial quotation
332 mark but the final quotation mark is missing.
333
334 This replaces a bogus and misleading error message about not finding the label
335 itself [perl #114104].
336
337 =item *
338
339 L<panic: child pseudo-process was never scheduled|perldiag/"panic: child pseudo-process was never scheduled">
340
341 This error is thrown when a child pseudo-process in the ithreads implementation
342 on Windows was not scheduled within the time period allowed and therefore was
343 not able to initialize properly [perl #88840].
344
345 =back
346
347 =head3 New Warnings
348
349 =over 4
350
351 =item *
352
353 L<Wide character in setenv|perldiag/"Wide character in %s">
354
355 Attempts to put wide characters into environment variables via C<%ENV> now
356 provoke this warning.
357
358 =back
359
360 =head2 Changes to Existing Diagnostics
361
362 XXX Changes (i.e. rewording) of diagnostic messages go here
363
364 =over 4
365
366 =item *
367
368 XXX Describe change here
369
370 =back
371
372 =head1 Utility Changes
373
374 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
375 Most of these are built within the directories F<utils> and F<x2p>.
376
377 [ List utility changes as a =head3 entry for each utility and =item
378 entries for each change
379 Use L<XXX> with program names to get proper documentation linking. ]
380
381 =head3 L<XXX>
382
383 =over 4
384
385 =item *
386
387 XXX
388
389 =back
390
391 =head1 Configuration and Compilation
392
393 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
394 go here.  Any other changes to the Perl build process should be listed here.
395 However, any platform-specific changes should be listed in the
396 L</Platform Support> section, instead.
397
398 [ List changes as a =item entry ].
399
400 =over 4
401
402 =item *
403
404 The pager detection in F<Configure> has been improved to allow responses which
405 specify options after the program name, e.g. B</usr/bin/less -R>, if the user
406 accepts the default value.  This helps B<perldoc> when handling ANSI escapes
407 [perl #72156].
408
409 =back
410
411 =head1 Testing
412
413 XXX Any significant changes to the testing of a freshly built perl should be
414 listed here.  Changes which create B<new> files in F<t/> go here as do any
415 large changes to the testing harness (e.g. when parallel testing was added).
416 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
417 that they represent may be covered elsewhere.
418
419 [ List each test improvement as a =item entry ]
420
421 =over 4
422
423 =item *
424
425 XXX
426
427 =back
428
429 =head1 Platform Support
430
431 XXX Any changes to platform support should be listed in the sections below.
432
433 [ Within the sections, list each platform as a =item entry with specific
434 changes as paragraphs below it. ]
435
436 =head2 New Platforms
437
438 XXX List any platforms that this version of perl compiles on, that previous
439 versions did not.  These will either be enabled by new files in the F<hints/>
440 directories, or new subdirectories and F<README> files at the top level of the
441 source tree.
442
443 =over 4
444
445 =item XXX-some-platform
446
447 XXX
448
449 =back
450
451 =head2 Discontinued Platforms
452
453 =over 4
454
455 =item UTS Global
456
457 Support code relating to UTS global has been removed.  UTS was a mainframe
458 version of System V created by Amdahl, subsequently sold to UTS Global.  The
459 port has not been touched since before 5.8.0, and UTS Global is now defunct.
460
461 =back
462
463 =head2 Platform-Specific Notes
464
465 XXX List any changes for specific platforms.  This could include configuration
466 and compilation changes or changes in portability/compatibility.  However,
467 changes within modules for platforms should generally be listed in the
468 L</Modules and Pragmata> section.
469
470 =over 4
471
472 =item Windows
473
474 A new makefile option, USE_64_BIT_INT, has been added to the Windows makefiles.
475 Set this to "define" when building a 32-bit perl if you want it to use 64-bit
476 integers.
477
478 Machine code size reductions, already made to the DLLs of XS modules in Perl
479 5.17.2, have now been extended to the perl DLL itself.
480
481 Building with VC++ 6.0 was inadvertently broken in Perl 5.17.2 but has now been
482 fixed again.  XXX Actually, it's now been broken again, so ensure that it gets
483 fixed once more before release, or remove this comment!
484
485 =item VMS
486
487 The B<a2p> build has been fixed for the HP C++ compiler on OpenVMS.
488
489 =back
490
491 =head1 Internal Changes
492
493 XXX Changes which affect the interface available to C<XS> code go here.  Other
494 significant internal changes for future core maintainers should be noted as
495 well.
496
497 [ List each change as a =item entry ]
498
499 =over 4
500
501 =item *
502
503 XXX
504
505 =back
506
507 =head1 Selected Bug Fixes
508
509 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
510 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
511
512 [ List each fix as a =item entry ]
513
514 =over 4
515
516 =item *
517
518 C<\w> now matches the code points U+200C (ZERO WIDTH NON-JOINER) and U+200D
519 (ZERO WIDTH JOINER).  C<\W> no longer matches these.  This change is because
520 Unicode corrected their definition of what C<\w> should match.
521
522 =item *
523
524 C<dump LABEL> no longer leaks its label.
525
526 =item *
527
528 Constant folding no longer changes the behaviour of functions like C<stat()>
529 and C<truncate()> that can take either filenames or handles.
530 C<stat 1 ? foo : bar> nows treats its argument as a file name (since it is an
531 arbitrary expression), rather than the handle "foo".
532
533 =item *
534
535 C<truncate FOO, $len> no longer falls back to treating "FOO" as a file name if
536 the filehandle has been deleted.  This was broken in Perl 5.16.0.
537
538 =item *
539
540 Subroutine redefinitions after sub-to-glob and glob-to-glob assignments no
541 longer cause double frees or panic messages.
542
543 =item *
544
545 C<s///> now turns vstrings into plain strings when performing a substitution,
546 even if the resulting string is the same (C<s/a/a/>).
547
548 =item *
549
550 Prototype mismatch warnings no longer erroneously treat constant subs as having
551 no prototype when they actually have "".
552
553 =item *
554
555 Constant subroutines and forward declarations no longer prevent prototype
556 mismatch warnings from omitting the sub name.
557
558 =item *
559
560 C<undef> on a subroutine now clears call checkers.
561
562 =item *
563
564 The C<ref> operator started leaking memory on blessed objects in Perl 5.16.0.
565 This has been fixed [perl #114340].
566
567 =item *
568
569 C<use> no longer tries to parse its arguments as a statement, making
570 C<use constant { () };> a syntax error [perl #114222].
571
572 =item *
573
574 On debugging builds, "uninitialized" warnings inside formats no longer cause
575 assertion failures.
576
577 =item *
578
579 On debugging builds, subroutines nested inside formats no longer cause
580 assertion failures [perl #78550].
581
582 =item *
583
584 Formats and C<use> statements are now permitted inside formats.
585
586 =item *
587
588 C<print $x> and C<sub { print $x }->()> now always produce the same output.  It
589 was possible for the latter to refuse to close over $x if the variable was not
590 active; e.g., if it was defined outside a currently-running named subroutine.
591
592 =item *
593
594 Similarly, C<print $x> and C<print eval '$x'> now produce the same output.
595 This also allows "my $x if 0" variables to be seen in the debugger [perl
596 #114018].
597
598 =item *
599
600 Formats called recursively no longer stomp on their own lexical variables, but
601 each recursive call has its own set of lexicals.
602
603 =item *
604
605 Attempting to free an active format or the handle associated with it no longer
606 results in a crash.
607
608 =item *
609
610 Format parsing no longer gets confused by braces, semicolons and low-precedence
611 operators.  It used to be possible to use braces as format delimiters (instead
612 of C<=> and C<.>), but only sometimes.  Semicolons and low-precedence operators
613 in format argument lines no longer confuse the parser into ignoring the line's
614 return value.  In format argument lines, braces can now be used for anonymous
615 hashes, instead of being treated always as C<do> blocks.
616
617 =item *
618
619 Formats can now be nested inside code blocks in regular expressions and other
620 quoted constructs (C</(?{...})/> and C<qq/${...}/>) [perl #114040].
621
622 =item *
623
624 Formats are no longer created after compilation errors.
625
626 =item *
627
628 Some format syntax errors started causing crashes in Perl 5.17.2, but have now
629 been fixed.
630
631 =item *
632
633 Under debugging builds, the B<-DA> command line option started crashing in Perl
634 5.16.0.  It has been fixed [perl #114368].
635
636 =item *
637
638 Scope::Escape compatibility, which was broken in Perl 5.17.2, has been restored
639 [perl #113872].
640
641 =item *
642
643 A potential deadlock scenario involving the premature termination of a
644 pseudo-forked child in a Windows build with ithreads enabled has been fixed.
645 This resolves the common problem of the F<t/op/fork.t> test hanging on Windows
646 [perl #88840].
647
648 =item *
649
650 The microperl build, broken since Perl 5.15.7, has now been restored.
651
652 =item *
653
654 The code which generates errors from C<require()> could potentially read one or
655 two bytes before the start of the filename for filenames less than three bytes
656 long and ending C</\.p?\z/>.  This has now been fixed.  Note that it could
657 never have happened with module names given to C<use()> or C<require()> anyway.
658
659 =item *
660
661 The handling of pathnames of modules given to C<require()> has been made
662 thread-safe on VMS.
663
664 =item *
665
666 The C<re_compile()> API function, the entry point for perl's regex compiler,
667 was accidentally changed in Perl 5.17.1 to operate on the current engine.  This
668 has now been restored to its former core-engine-specific state [perl #114302].
669
670 =item *
671
672 Perl 5.17.1 introduced a memory leak into the re-use of run-time regexes where
673 the pattern hasn't changed (i.e. C</$unchanging/>).  This has now been fixed.
674
675 =item *
676
677 A bug in the compilation of a C</(?{})/> expression which affected the TryCatch
678 test suite has been fixed [perl #114242].
679
680 =back
681
682 =head1 Known Problems
683
684 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
685 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
686 platform specific bugs also go here.
687
688 [ List each fix as a =item entry ]
689
690 =over 4
691
692 =item *
693
694 XXX
695
696 =back
697
698 =head1 Obituary
699
700 XXX If any significant core contributor has died, we've added a short obituary
701 here.
702
703 =head1 Acknowledgements
704
705 XXX Generate this with:
706
707   perl Porting/acknowledgements.pl v5.17.2..HEAD
708
709 =head1 Reporting Bugs
710
711 If you find what you think is a bug, you might check the articles recently
712 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
713 http://rt.perl.org/perlbug/ .  There may also be information at
714 http://www.perl.org/ , the Perl Home Page.
715
716 If you believe you have an unreported bug, please run the L<perlbug> program
717 included with your release.  Be sure to trim your bug down to a tiny but
718 sufficient test case.  Your bug report, along with the output of C<perl -V>,
719 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
720
721 If the bug you are reporting has security implications, which make it
722 inappropriate to send to a publicly archived mailing list, then please send it
723 to perl5-security-report@perl.org.  This points to a closed subscription
724 unarchived mailing list, which includes all the core committers, who will be
725 able to help assess the impact of issues, figure out a resolution, and help
726 co-ordinate the release of patches to mitigate or fix the problem across all
727 platforms on which Perl is supported.  Please only use this address for
728 security issues in the Perl core, not for modules independently distributed on
729 CPAN.
730
731 =head1 SEE ALSO
732
733 The F<Changes> file for an explanation of how to view exhaustive details on
734 what changed.
735
736 The F<INSTALL> file for how to build Perl.
737
738 The F<README> file for general stuff.
739
740 The F<Artistic> and F<Copying> files for copyright information.
741
742 =cut