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