This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Minor perldelta changes
[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
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 1.91 to 1.92.  XXX Add change
128 notes.
129
130 =item *
131
132 L<B::Deparse> has been upgraded from version 1.15 to 1.16.  It now deparses
133 loop controls with the correct precedence.
134
135 =item *
136
137 L<Compress::Raw::Bzip2> has been upgraded from version 2.05201 to 2.055.  XXX
138 Add change notes.
139
140 =item *
141
142 L<Compress::Raw::Zlib> has been upgraded from version 2.05401 to 2.056.  XXX
143 Add change notes.
144
145 =item *
146
147 L<Data::Dumper> has been upgraded from version 2.135_06 to 2.135_07.  It has
148 been optimized to only build a seen-scalar hash as necessary, thereby speeding
149 up serialization drastically.
150
151 =item *
152
153 L<Devel::Peek> has been upgraded from version 1.08 to 1.09.  XXX Add change
154 notes.
155
156 =item *
157
158 L<Encode> has been upgraded from version 2.44 to 2.46.  XXX Add change notes.
159
160 =item *
161
162 L<IO::Compress> has been upgraded from version 2.052 to 2.055.  XXX Add change
163 notes.
164
165 =item *
166
167 L<Module::Build> has been upgraded from version 0.40 to 0.4002.  XXX Add change
168 notes.
169
170 =item *
171
172 L<Module::CoreList> has been upgraded from version 2.69 to 2.70.  XXX Add
173 change notes.
174
175 =item *
176
177 L<Module::Load::Conditional> has been upgraded from version 0.50 to 0.54.  XXX
178 Add change notes.
179
180 =item *
181
182 L<Module::Metadata> has been upgraded from version 1.000009 to 1.000010.  XXX
183 Add change notes.
184
185 =item *
186
187 L<re> has been upgraded from version 0.21 to 0.22.  XXX Add change notes.
188
189 =item *
190
191 L<Storable> has been upgraded from version 2.37 to 2.38.  It can now freeze
192 and thaw vstrings correctly.  This causes a slight incompatible change in
193 the storage format, so the format version has increased to 2.9.
194
195 =item *
196
197 L<Time::Local> has been upgraded from version 1.2000 to 1.2300.  XXX Add change
198 notes.
199
200 =item *
201
202 L<Unicode::UCD> has been upgraded from version 0.44 to 0.45.  XXX Add change
203 notes.
204
205 =item *
206
207 L<Win32CORE> has been upgraded from version 0.02 to 0.03.  XXX Add change
208 notes.
209
210 =back
211
212 =head2 Removed Modules and Pragmata
213
214 =over 4
215
216 =item *
217
218 XXX
219
220 =back
221
222 =head1 Documentation
223
224 XXX Changes to files in F<pod/> go here.  Consider grouping entries by file and
225 be sure to link to the appropriate page, e.g. L<perlfunc>.
226
227 =head2 New Documentation
228
229 XXX Changes which create B<new> files in F<pod/> go here.
230
231 =head3 L<XXX>
232
233 XXX Description of the purpose of the new file here
234
235 =head2 Changes to Existing Documentation
236
237 XXX Changes which significantly change existing files in F<pod/> go here.
238 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
239 section.
240
241 =head3 L<perlfunc>, L<perlop>
242
243 =over 4
244
245 =item *
246
247 Loop control verbs (C<dump>, C<goto>, C<next>, C<last> and C<redo>) have
248 always had the same precedence as assignment operators, but this was never
249 documented until now.
250
251 =back
252
253 =head1 Diagnostics
254
255 The following additions or changes have been made to diagnostic output,
256 including warnings and fatal error messages.  For the complete list of
257 diagnostic messages, see L<perldiag>.
258
259 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
260 include any changes in L<perldiag> that reconcile it to the C<C> code.
261
262 =head2 New Diagnostics
263
264 XXX Newly added diagnostic messages go under here, separated into New Errors
265 and New Warnings
266
267 =head3 New Errors
268
269 =over 4
270
271 =item *
272
273 L<Unterminated delimiter for here document|perldiag/"Unterminated delimiter for here document">
274
275 This message now occurs when a here document label has an initial quotation
276 mark but the final quotation mark is missing.
277
278 This replaces a bogus and misleading error message about not finding the
279 label itself [perl #114104].
280
281 =back
282
283 =head3 New Warnings
284
285 =over 4
286
287 =item *
288
289 L<Wide character in setenv|perldiag/"Wide character in setenv">
290
291 Attempts to put wide characters into environment variables via C<%ENV> now
292 provoke this warning.
293
294 =back
295
296 =head2 Changes to Existing Diagnostics
297
298 XXX Changes (i.e. rewording) of diagnostic messages go here
299
300 =over 4
301
302 =item *
303
304 XXX Describe change here
305
306 =back
307
308 =head1 Utility Changes
309
310 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
311 Most of these are built within the directories F<utils> and F<x2p>.
312
313 [ List utility changes as a =head3 entry for each utility and =item
314 entries for each change
315 Use L<XXX> with program names to get proper documentation linking. ]
316
317 =head3 L<XXX>
318
319 =over 4
320
321 =item *
322
323 XXX
324
325 =back
326
327 =head1 Configuration and Compilation
328
329 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
330 go here.  Any other changes to the Perl build process should be listed here.
331 However, any platform-specific changes should be listed in the
332 L</Platform Support> section, instead.
333
334 [ List changes as a =item entry ].
335
336 =over 4
337
338 =item *
339
340 XXX
341
342 =back
343
344 =head1 Testing
345
346 XXX Any significant changes to the testing of a freshly built perl should be
347 listed here.  Changes which create B<new> files in F<t/> go here as do any
348 large changes to the testing harness (e.g. when parallel testing was added).
349 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
350 that they represent may be covered elsewhere.
351
352 [ List each test improvement as a =item entry ]
353
354 =over 4
355
356 =item *
357
358 XXX
359
360 =back
361
362 =head1 Platform Support
363
364 XXX Any changes to platform support should be listed in the sections below.
365
366 [ Within the sections, list each platform as a =item entry with specific
367 changes as paragraphs below it. ]
368
369 =head2 New Platforms
370
371 XXX List any platforms that this version of perl compiles on, that previous
372 versions did not . These will either be enabled by new files in the F<hints/>
373 directories, or new subdirectories and F<README> files at the top level of the
374 source tree.
375
376 =over 4
377
378 =item XXX-some-platform
379
380 XXX
381
382 =back
383
384 =head2 Discontinued Platforms
385
386 XXX List any platforms that this version of perl no longer compiles on.
387
388 =over 4
389
390 =item XXX-some-platform
391
392 XXX
393
394 =back
395
396 =head2 Platform-Specific Notes
397
398 XXX List any changes for specific platforms.  This could include configuration
399 and compilation changes or changes in portability/compatibility.  However,
400 changes within modules for platforms should generally be listed in the
401 L</Modules and Pragmata> section.
402
403 =over 4
404
405 =item XXX-some-platform
406
407 XXX
408
409 =back
410
411 =head1 Internal Changes
412
413 XXX Changes which affect the interface available to C<XS> code go here.  Other
414 significant internal changes for future core maintainers should be noted as
415 well.
416
417 [ List each change as a =item entry ]
418
419 =over 4
420
421 =item *
422
423 XXX
424
425 =back
426
427 =head1 Selected Bug Fixes
428
429 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
430 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
431
432 [ List each fix as a =item entry ]
433
434 =over 4
435
436 =item *
437
438 C<\w> now matches the code points U+200C (ZERO WIDTH NON-JOINER) and
439 U+200D (ZERO WIDTH JOINER).  C<\W> no longer matches these.  This change
440 is because Unicode corrected their definition of what C<\w> should match.
441
442 =item *
443
444 C<dump LABEL> no longer leaks its label.
445
446 =item *
447
448 Constant folding no longer changes the behaviour of functions like C<stat()>
449 and C<truncate()> that can take either filenames or handles.
450 C<stat 1 ? foo : bar> nows treats its argument as a file name (since it is
451 an arbitrary expression), rather than the handle "foo".
452
453 =item *
454
455 C<truncate FOO, $len> no longer falls back to treating "FOO" as a file name
456 if the filehandle has been deleted.  This was broken in Perl 5.16.0.
457
458 =item *
459
460 Subroutine redefinitions after sub-to-glob and glob-to-glob assignments no
461 longer cause double frees or panic messages.
462
463 =item *
464
465 C<s///> now turns vstrings into plain strings when performing a
466 substitution, even if the resulting string is the same (C<s/a/a/>).
467
468 =item *
469
470 Prototype mismatch warnings no longer erroneously treat constant subs as
471 having no prototype when they actually have "".
472
473 =item *
474
475 Constant subroutines and forward declarations no longer prevent prototype
476 mismatch warnings from omitting the sub name.
477
478 =item *
479
480 C<undef> on a subroutine now clears call checkers.
481
482 =item *
483
484 The C<ref> operator started leaking memory on blessed objects in Perl
485 5.16.0.  This has been fixed [perl #114340].
486
487 =back
488
489 =head1 Known Problems
490
491 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
492 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
493 platform specific bugs also go here.
494
495 [ List each fix as a =item entry ]
496
497 =over 4
498
499 =item *
500
501 XXX
502
503 =back
504
505 =head1 Obituary
506
507 XXX If any significant core contributor has died, we've added a short obituary
508 here.
509
510 =head1 Acknowledgements
511
512 XXX Generate this with:
513
514   perl Porting/acknowledgements.pl v5.17.2..HEAD
515
516 =head1 Reporting Bugs
517
518 If you find what you think is a bug, you might check the articles recently
519 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
520 http://rt.perl.org/perlbug/ .  There may also be information at
521 http://www.perl.org/ , the Perl Home Page.
522
523 If you believe you have an unreported bug, please run the L<perlbug> program
524 included with your release.  Be sure to trim your bug down to a tiny but
525 sufficient test case.  Your bug report, along with the output of C<perl -V>,
526 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
527
528 If the bug you are reporting has security implications, which make it
529 inappropriate to send to a publicly archived mailing list, then please send it
530 to perl5-security-report@perl.org.  This points to a closed subscription
531 unarchived mailing list, which includes all the core committers, who will be
532 able to help assess the impact of issues, figure out a resolution, and help
533 co-ordinate the release of patches to mitigate or fix the problem across all
534 platforms on which Perl is supported.  Please only use this address for
535 security issues in the Perl core, not for modules independently distributed on
536 CPAN.
537
538 =head1 SEE ALSO
539
540 The F<Changes> file for an explanation of how to view exhaustive details on
541 what changed.
542
543 The F<INSTALL> file for how to build Perl.
544
545 The F<README> file for general stuff.
546
547 The F<Artistic> and F<Copying> files for copyright information.
548
549 =cut