perldelta
[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
34 run time.  Previously, any argument that was not a constant was treated as
35 the 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
52 versions 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
57 this release, it is converted to be only a byte string.  First, it is forced
58 to be a 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>).
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<Compress::Raw::Bzip2> has been upgraded from version 2.05201 to 2.055.  The
141 misuse of Perl's "magic" API has been fixed.
142
143 =item *
144
145 L<Compress::Raw::Zlib> has been upgraded from version 2.05401 to 2.056.  The
146 misuse of Perl's "magic" API has been fixed.
147
148 =item *
149
150 L<Compress::Zlib> has been upgraded from version 2.052 to 2.055.
151 C<compress()>, C<uncompress()>, C<memGzip()> and C<memGunzip()> have been
152 speeded up by making parameter validation more efficient.
153
154 =item *
155
156 L<Data::Dumper> has been upgraded from version 2.135_06 to 2.135_07.  It has
157 been optimized to only build a seen-scalar hash as necessary, thereby speeding
158 up serialization drastically.
159
160 =item *
161
162 L<Devel::Peek> has been upgraded from version 1.08 to 1.09.  The only change has
163 been to the test script, to account for changes to some flags in perl's
164 internals.
165
166 =item *
167
168 L<Encode> has been upgraded from version 2.44 to 2.47.  The Mac alias x-mac-ce
169 has been added, and various bugs have been fixed in Encode::Unicode,
170 Encode::UTF7 and Encode::GSM0338.
171
172 =item *
173
174 L<Module::Build> has been upgraded from version 0.40 to 0.4002.  A minor bug fix
175 allows markup to be used around the leading "Name" in a POD "abstract" line, and
176 some documentation improvements have been made.
177
178 =item *
179
180 L<Module::CoreList> has been upgraded from version 2.69 to 2.70.  Version
181 information is now stored as a delta, which greatly reduces the size of the
182 F<CoreList.pm> file.
183
184 =item *
185
186 L<Module::Load::Conditional> has been upgraded from version 0.50 to 0.54.
187 Various enhancements include the new use of Module::Metadata.
188
189 =item *
190
191 L<Module::Metadata> has been upgraded from version 1.000009 to 1.000010.  The
192 creation of a Module::Metadata object for a typical module file has been sped up
193 by about 40%.
194
195 =item *
196
197 L<Module::Pluggable> has been upgraded from version 4.0 to 4.2.  XXX TODO
198
199 =item *
200
201 L<Pod::Simple> has been upgraded from version 3.20 to 3.23.  Numerous
202 improvements have been made, mostly to Pod::Simple::XHTML, which also has a
203 compatibility change: the C<codes_in_verbatim> option is now disabled by
204 default.  See F<cpan/Pod-Simple/ChangeLog> for the full details.
205
206 =item *
207
208 L<re> has been upgraded from version 0.21 to 0.22.  Single character [class]es
209 like C</[s]/> or C</[s]/i> are now optimized as if they did not have the
210 brackets, i.e. C</s/> or C</s/i>.
211
212 =item *
213
214 L<Storable> has been upgraded from version 2.37 to 2.38.  It can now freeze
215 and thaw vstrings correctly.  This causes a slight incompatible change in
216 the storage format, so the format version has increased to 2.9.
217
218 =item *
219
220 L<Sys::Syslog> has been upgraded from version 0.29 to 0.30.  An issue with
221 C<POSIX::strftime()> on Windows and a build problem on Haiku-OS have been
222 resolved, and <getservbyname()> is no longer called when the port is specified.
223
224 =item *
225
226 L<Time::Local> has been upgraded from version 1.2000 to 1.2300.  Seconds values
227 greater than 59 but less than 60 no longer cause C<timegm()> and C<timelocal()>
228 to croak.
229
230 =item *
231
232 L<Unicode::UCD> has been upgraded from version 0.44 to 0.45.  This has been
233 modified slightly for reasons of perl internal use only.
234
235 =item *
236
237 L<Win32> has been upgraded from version 0.44 to 0.45.  New APIs have been added
238 for getting and setting the current code page.
239
240 =item *
241
242 L<Win32CORE> has been upgraded from version 0.02 to 0.03.  The use of
243 PERL_NO_GET_CONTEXT here has resulted in smaller machine code.
244
245 =back
246
247 =head1 Documentation
248
249 XXX Changes to files in F<pod/> go here.  Consider grouping entries by file and
250 be sure to link to the appropriate page, e.g. L<perlfunc>.
251
252 =head2 New Documentation
253
254 XXX Changes which create B<new> files in F<pod/> go here.
255
256 =head3 L<XXX>
257
258 XXX Description of the purpose of the new file here
259
260 =head2 Changes to Existing Documentation
261
262 XXX Changes which significantly change existing files in F<pod/> go here.
263 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
264 section.
265
266 =head3 L<perlfunc>, L<perlop>
267
268 =over 4
269
270 =item *
271
272 Loop control verbs (C<dump>, C<goto>, C<next>, C<last> and C<redo>) have
273 always had the same precedence as assignment operators, but this was never
274 documented until now.
275
276 =back
277
278 =head1 Diagnostics
279
280 The following additions or changes have been made to diagnostic output,
281 including warnings and fatal error messages.  For the complete list of
282 diagnostic messages, see L<perldiag>.
283
284 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
285 include any changes in L<perldiag> that reconcile it to the C<C> code.
286
287 =head2 New Diagnostics
288
289 XXX Newly added diagnostic messages go under here, separated into New Errors
290 and New Warnings
291
292 =head3 New Errors
293
294 =over 4
295
296 =item *
297
298 L<Unterminated delimiter for here document|perldiag/"Unterminated delimiter for here document">
299
300 This message now occurs when a here document label has an initial quotation
301 mark but the final quotation mark is missing.
302
303 This replaces a bogus and misleading error message about not finding the
304 label itself [perl #114104].
305
306 =back
307
308 =head3 New Warnings
309
310 =over 4
311
312 =item *
313
314 L<Wide character in setenv|perldiag/"Wide character in %s">
315
316 Attempts to put wide characters into environment variables via C<%ENV> now
317 provoke this warning.
318
319 =back
320
321 =head2 Changes to Existing Diagnostics
322
323 XXX Changes (i.e. rewording) of diagnostic messages go here
324
325 =over 4
326
327 =item *
328
329 XXX Describe change here
330
331 =back
332
333 =head1 Utility Changes
334
335 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
336 Most of these are built within the directories F<utils> and F<x2p>.
337
338 [ List utility changes as a =head3 entry for each utility and =item
339 entries for each change
340 Use L<XXX> with program names to get proper documentation linking. ]
341
342 =head3 L<XXX>
343
344 =over 4
345
346 =item *
347
348 XXX
349
350 =back
351
352 =head1 Configuration and Compilation
353
354 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
355 go here.  Any other changes to the Perl build process should be listed here.
356 However, any platform-specific changes should be listed in the
357 L</Platform Support> section, instead.
358
359 [ List changes as a =item entry ].
360
361 =over 4
362
363 =item *
364
365 XXX
366
367 =back
368
369 =head1 Testing
370
371 XXX Any significant changes to the testing of a freshly built perl should be
372 listed here.  Changes which create B<new> files in F<t/> go here as do any
373 large changes to the testing harness (e.g. when parallel testing was added).
374 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
375 that they represent may be covered elsewhere.
376
377 [ List each test improvement as a =item entry ]
378
379 =over 4
380
381 =item *
382
383 XXX
384
385 =back
386
387 =head1 Platform Support
388
389 XXX Any changes to platform support should be listed in the sections below.
390
391 [ Within the sections, list each platform as a =item entry with specific
392 changes as paragraphs below it. ]
393
394 =head2 New Platforms
395
396 XXX List any platforms that this version of perl compiles on, that previous
397 versions did not . These will either be enabled by new files in the F<hints/>
398 directories, or new subdirectories and F<README> files at the top level of the
399 source tree.
400
401 =over 4
402
403 =item XXX-some-platform
404
405 XXX
406
407 =back
408
409 =head2 Discontinued Platforms
410
411 XXX List any platforms that this version of perl no longer compiles on.
412
413 =over 4
414
415 =item XXX-some-platform
416
417 XXX
418
419 =back
420
421 =head2 Platform-Specific Notes
422
423 XXX List any changes for specific platforms.  This could include configuration
424 and compilation changes or changes in portability/compatibility.  However,
425 changes within modules for platforms should generally be listed in the
426 L</Modules and Pragmata> section.
427
428 =over 4
429
430 =item XXX-some-platform
431
432 XXX
433
434 =back
435
436 =head1 Internal Changes
437
438 XXX Changes which affect the interface available to C<XS> code go here.  Other
439 significant internal changes for future core maintainers should be noted as
440 well.
441
442 [ List each change as a =item entry ]
443
444 =over 4
445
446 =item *
447
448 XXX
449
450 =back
451
452 =head1 Selected Bug Fixes
453
454 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
455 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
456
457 [ List each fix as a =item entry ]
458
459 =over 4
460
461 =item *
462
463 C<\w> now matches the code points U+200C (ZERO WIDTH NON-JOINER) and
464 U+200D (ZERO WIDTH JOINER).  C<\W> no longer matches these.  This change
465 is because Unicode corrected their definition of what C<\w> should match.
466
467 =item *
468
469 C<dump LABEL> no longer leaks its label.
470
471 =item *
472
473 Constant folding no longer changes the behaviour of functions like C<stat()>
474 and C<truncate()> that can take either filenames or handles.
475 C<stat 1 ? foo : bar> nows treats its argument as a file name (since it is
476 an arbitrary expression), rather than the handle "foo".
477
478 =item *
479
480 C<truncate FOO, $len> no longer falls back to treating "FOO" as a file name
481 if the filehandle has been deleted.  This was broken in Perl 5.16.0.
482
483 =item *
484
485 Subroutine redefinitions after sub-to-glob and glob-to-glob assignments no
486 longer cause double frees or panic messages.
487
488 =item *
489
490 C<s///> now turns vstrings into plain strings when performing a
491 substitution, even if the resulting string is the same (C<s/a/a/>).
492
493 =item *
494
495 Prototype mismatch warnings no longer erroneously treat constant subs as
496 having no prototype when they actually have "".
497
498 =item *
499
500 Constant subroutines and forward declarations no longer prevent prototype
501 mismatch warnings from omitting the sub name.
502
503 =item *
504
505 C<undef> on a subroutine now clears call checkers.
506
507 =item *
508
509 The C<ref> operator started leaking memory on blessed objects in Perl
510 5.16.0.  This has been fixed [perl #114340].
511
512 =item *
513
514 C<use> no longer tries to parse its arguments as a statement, making
515 C<use constant { () };> a syntax error [perl #114222].
516
517 =item *
518
519 On debugging builds, "uninitialized" warnings inside formats no longer
520 cause assertion failures.
521
522 =item *
523
524 On debugging builds, subroutines nested inside formats no longer cause
525 assertion failures [perl #78550].
526
527 =item *
528
529 C<print $x> and C<sub { print $x }->()> now always produce the same output.
530 It was possible for the latter to refuse to close over $x if the variable
531 was not active; e.g., if it was defined outside a currently-running named
532 subroutine.
533
534 =item *
535
536 Similarly, C<print $x> and C<print eval '$x'> now produce the same output.
537 This also allows "my $x if 0" variables to be seen in the debugger
538 [perl #114018].
539
540 =item *
541
542 Formats called recursively no longer stomp on their own lexical variables,
543 but each recursive call has its own set of lexicals.
544
545 =item *
546
547 Attempting to free an active format or the handle associated with it no
548 longer results in a crash.
549
550 =item *
551
552 Format parsing no longer gets confused by braces, semicolons and
553 low-precedence operators.  It used to be possible to use braces as format
554 delimiters (instead of C<=> and C<.>), but only sometimes.  Semicolons and
555 low-precedence operators in format argument lines no longer confuse the
556 parser into ignoring the line's return value.  In format argument lines,
557 braces can now be used for anonymous hashes, instead of being treated
558 always as C<do> blocks.
559
560 =item *
561
562 Formats can now be nested inside code blocks in regular expressions and
563 other quoted constructs (C</(?{...})/> and C<qq/${...}/>) [perl #114040].
564
565 =item *
566
567 Formats are no longer created after compilation errors.
568
569 =back
570
571 =head1 Known Problems
572
573 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
574 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
575 platform specific bugs also go here.
576
577 [ List each fix as a =item entry ]
578
579 =over 4
580
581 =item *
582
583 XXX
584
585 =back
586
587 =head1 Obituary
588
589 XXX If any significant core contributor has died, we've added a short obituary
590 here.
591
592 =head1 Acknowledgements
593
594 XXX Generate this with:
595
596   perl Porting/acknowledgements.pl v5.17.2..HEAD
597
598 =head1 Reporting Bugs
599
600 If you find what you think is a bug, you might check the articles recently
601 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
602 http://rt.perl.org/perlbug/ .  There may also be information at
603 http://www.perl.org/ , the Perl Home Page.
604
605 If you believe you have an unreported bug, please run the L<perlbug> program
606 included with your release.  Be sure to trim your bug down to a tiny but
607 sufficient test case.  Your bug report, along with the output of C<perl -V>,
608 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
609
610 If the bug you are reporting has security implications, which make it
611 inappropriate to send to a publicly archived mailing list, then please send it
612 to perl5-security-report@perl.org.  This points to a closed subscription
613 unarchived mailing list, which includes all the core committers, who will be
614 able to help assess the impact of issues, figure out a resolution, and help
615 co-ordinate the release of patches to mitigate or fix the problem across all
616 platforms on which Perl is supported.  Please only use this address for
617 security issues in the Perl core, not for modules independently distributed on
618 CPAN.
619
620 =head1 SEE ALSO
621
622 The F<Changes> file for an explanation of how to view exhaustive details on
623 what changed.
624
625 The F<INSTALL> file for how to build Perl.
626
627 The F<README> file for general stuff.
628
629 The F<Artistic> and F<Copying> files for copyright information.
630
631 =cut