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