This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
dd5536368d835d9e7074b2eca562a7a85359f563
[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
6 XXX needs 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
13 the 5.17.3 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
17 5.17.2.
18
19 =head1 Notice
20
21 XXX Any important notices here
22
23 =head1 Core Enhancements
24
25 XXX New core language features go here. Summarise user-visible core language
26 enhancements. Particularly prominent performance optimisations could go
27 here, but most should go in the L</Performance Enhancements> section.
28
29 [ List each enhancement as a =head2 entry ]
30
31 =head2 Computed Labels
32
33 The loop controls C<next>, C<last> and C<redo>, and the special C<dump>
34 operator, now allow arbitrary expressions to be used to compute labels at
35 run time.  Previously, any argument that was not a constant was treated as
36 the empty string.
37
38 =head1 Security
39
40 XXX Any security-related notices go here.  In particular, any security
41 vulnerabilities closed should be noted here rather than in the
42 L</Selected Bug Fixes> section.
43
44 [ List each security issue as a =head2 entry ]
45
46 =head1 Incompatible Changes
47
48 [ List each incompatible change as a =head2 entry ]
49
50 =head2 C<$ENV{foo} = undef> deletes value from environ, like C<delete $ENV{foo}>
51
52 This facilitates use of C<local()> with C<%ENV> entries.  In previous
53 versions of Perl, C<undef> was converted to the empty string.
54
55 =head2 Defined values stored in environment are forced to byte strings
56
57 A value stored in an environment variable has always been stringified.  In
58 this release, it is converted to be only a byte string.  First, it is forced
59 to be a only a string.  Then if the string is utf8 and the equivalent of
60 C<utf8::downgrade> works, that result is used; otherwise, the equivalent of
61 C<utf8::encode> is used, and a warning is issued about wide characters
62 (L</Diagnostics>).
63
64 =head2 C<given> now aliases the global $_
65
66 Instead of assigning to an implicit lexical $_, C<given> now makes the
67 global $_ an alias for its argument, just like C<foreach>.  However, it
68 still uses lexical $_ if there is lexical $_ in scope (again, just like
69 C<foreach>).
70
71 =head1 Deprecations
72
73 XXX Any deprecated features, syntax, modules etc. should be listed here.
74 In particular, deprecated modules should be listed here even if they are
75 listed as an updated module in the L</Modules and Pragmata> section.
76
77 [ List each deprecation as a =head2 entry ]
78
79 =head1 Performance Enhancements
80
81 XXX Changes which enhance performance without changing behaviour go here. There
82 may well be none in a stable release.
83
84 [ List each enhancement as a =item entry ]
85
86 =over 4
87
88 =item *
89
90 XXX
91
92 =back
93
94 =head1 Modules and Pragmata
95
96 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
97 go here.  If Module::CoreList is updated, generate an initial draft of the
98 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
99 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
100 below.  A paragraph summary for important changes should then be added by hand.
101 In an ideal world, dual-life modules would have a F<Changes> file that could be
102 cribbed.
103
104 [ Within each section, list entries as a =item entry ]
105
106 =head2 New Modules and Pragmata
107
108 =over 4
109
110 =item *
111
112 XXX
113
114 =back
115
116 =head2 Updated Modules and Pragmata
117
118 =over 4
119
120 =item *
121
122 L<B> has been upgraded from version 1.36 to version 1.37. All C<CVf_*> and
123 C<GVf_*> and more SV-related flag values are now provided as constants in
124 the C<B::> namespace and available for export. The default export list has
125 not changed.
126
127 =item *
128
129 L<B::Deparse> has been upgraded from version 1.15 to 1.16.  It now deparses
130 loop controls with the correct precedence.
131
132 =back
133
134 =head2 Removed Modules and Pragmata
135
136 =over 4
137
138 =item *
139
140 XXX
141
142 =back
143
144 =head1 Documentation
145
146 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
147 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
148
149 =head2 New Documentation
150
151 XXX Changes which create B<new> files in F<pod/> go here.
152
153 =head3 L<XXX>
154
155 XXX Description of the purpose of the new file here
156
157 =head2 Changes to Existing Documentation
158
159 XXX Changes which significantly change existing files in F<pod/> go here.
160 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
161 section.
162
163 =head3 L<perlfunc>, L<perlop>
164
165 =over 4
166
167 =item *
168
169 Loop control verbs (C<dump>, C<goto>, C<next>, C<last> and C<redo>) have
170 always had the same precedence as assignment operators, but this was never
171 documented until now.
172
173 =back
174
175 =head1 Diagnostics
176
177 The following additions or changes have been made to diagnostic output,
178 including warnings and fatal error messages.  For the complete list of
179 diagnostic messages, see L<perldiag>.
180
181 XXX New or changed warnings emitted by the core's C<C> code go here. Also
182 include any changes in L<perldiag> that reconcile it to the C<C> code.
183
184 [ Within each section, list entries as a =item entry that links to perldiag,
185   e.g.
186
187   =item *
188
189   L<Invalid version object|perldiag/"Invalid version object">
190 ]
191
192 =head2 New Diagnostics
193
194 XXX Newly added diagnostic messages go here
195
196 =over 4
197
198 =item *
199
200 Attempts to put wide characters into environment variables via %ENV provoke
201 the warning "Wide character in setenv".
202
203 =back
204
205 =head3 New Errors
206
207 =over 4
208
209 =item *
210
211 XXX L<message|perldiag/"message">
212
213 =back
214
215 =head3 New Warnings
216
217 =over 4
218
219 =item *
220
221 XXX L<message|perldiag/"message">
222
223 =back
224
225 =head2 Changes to Existing Diagnostics
226
227 XXX Changes (i.e. rewording) of diagnostic messages go here
228
229 =over 4
230
231 =item *
232
233 XXX Describe change here
234
235 =back
236
237 =head1 Utility Changes
238
239 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
240 here. Most of these are built within the directories F<utils> and F<x2p>.
241
242 [ List utility changes as a =head3 entry for each utility and =item
243 entries for each change
244 Use L<XXX> with program names to get proper documentation linking. ]
245
246 =head3 L<XXX>
247
248 =over 4
249
250 =item *
251
252 XXX
253
254 =back
255
256 =head1 Configuration and Compilation
257
258 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
259 go here.  Any other changes to the Perl build process should be listed here.
260 However, any platform-specific changes should be listed in the
261 L</Platform Support> section, instead.
262
263 [ List changes as a =item entry ].
264
265 =over 4
266
267 =item *
268
269 XXX
270
271 =back
272
273 =head1 Testing
274
275 XXX Any significant changes to the testing of a freshly built perl should be
276 listed here.  Changes which create B<new> files in F<t/> go here as do any
277 large changes to the testing harness (e.g. when parallel testing was added).
278 Changes to existing files in F<t/> aren't worth summarising, although the bugs
279 that they represent may be covered elsewhere.
280
281 [ List each test improvement as a =item entry ]
282
283 =over 4
284
285 =item *
286
287 XXX
288
289 =back
290
291 =head1 Platform Support
292
293 XXX Any changes to platform support should be listed in the sections below.
294
295 [ Within the sections, list each platform as a =item entry with specific
296 changes as paragraphs below it. ]
297
298 =head2 New Platforms
299
300 XXX List any platforms that this version of perl compiles on, that previous
301 versions did not. These will either be enabled by new files in the F<hints/>
302 directories, or new subdirectories and F<README> files at the top level of the
303 source tree.
304
305 =over 4
306
307 =item XXX-some-platform
308
309 XXX
310
311 =back
312
313 =head2 Discontinued Platforms
314
315 XXX List any platforms that this version of perl no longer compiles on.
316
317 =over 4
318
319 =item XXX-some-platform
320
321 XXX
322
323 =back
324
325 =head2 Platform-Specific Notes
326
327 XXX List any changes for specific platforms. This could include configuration
328 and compilation changes or changes in portability/compatibility.  However,
329 changes within modules for platforms should generally be listed in the
330 L</Modules and Pragmata> section.
331
332 =over 4
333
334 =item XXX-some-platform
335
336 XXX
337
338 =back
339
340 =head1 Internal Changes
341
342 XXX Changes which affect the interface available to C<XS> code go here.
343 Other significant internal changes for future core maintainers should
344 be noted as well.
345
346 [ List each change as a =item entry ]
347
348 =over 4
349
350 =item *
351
352 XXX
353
354 =back
355
356 =head1 Selected Bug Fixes
357
358 XXX Important bug fixes in the core language are summarised here.
359 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
360 L</Modules and Pragmata>.
361
362 [ List each fix as a =item entry ]
363
364 =over 4
365
366 =item *
367
368 C<\w> now matches the code points U+200C (ZERO WIDTH NON-JOINER) and
369 U+200D (ZERO WIDTH JOINER).  C<\W> no longer matches these.  This change
370 is because Unicode corrected their definition of what C<\w> should match.
371
372 =item *
373
374 C<dump LABEL> no longer leaks its label.
375
376 =item *
377
378 Constant folding no longer changes the behaviour of functions like C<stat>
379 and C<truncate> that can take either filenames or handles.
380 C<stat 1 ? foo : bar> nows treats its argument as a file name (since it is
381 an arbitrary expression), rather than the handle "foo".
382
383 =item *
384
385 C<truncate FOO, $len> no longer falls back to treating "FOO" as a file name
386 if the filehandle has been deleted.  This was broken in Perl 5.16.0.
387
388 =item *
389
390 Subroutine redefinitions after sub-to-glob and glob-to-glob assignments no
391 longer cause double frees or panic messages.
392
393 =item *
394
395 C<s///> now turns vstrings into plain strings when performing a
396 substitution, even if the resulting string is the same (C<s/a/a/>).
397
398 =item *
399
400 Prototype mismatch warnings no longer erroneously treat constant subs as
401 having no prototype when they actually have "".
402
403 =item *
404
405 Constant subroutines and forward declarations no longer prevent prototype
406 mismatch warnings from omitting the sub name.
407
408 =item *
409
410 C<undef> on a subroutine now clears call checkers.
411
412 =back
413
414 =head1 Known Problems
415
416 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
417 tests that had to be C<TODO>ed for the release would be noted here. Unfixed
418 platform specific bugs also go here.
419
420 [ List each fix as a =item entry ]
421
422 =over 4
423
424 =item *
425
426 XXX
427
428 =back
429
430 =head1 Obituary
431
432 XXX If any significant core contributor has died, we've added a short obituary
433 here.
434
435 =head1 Acknowledgements
436
437 XXX Generate this with:
438
439   perl Porting/acknowledgements.pl v5.17.2..HEAD
440
441 =head1 Reporting Bugs
442
443 If you find what you think is a bug, you might check the articles
444 recently posted to the comp.lang.perl.misc newsgroup and the perl
445 bug database at http://rt.perl.org/perlbug/ .  There may also be
446 information at http://www.perl.org/ , the Perl Home Page.
447
448 If you believe you have an unreported bug, please run the L<perlbug>
449 program included with your release.  Be sure to trim your bug down
450 to a tiny but sufficient test case.  Your bug report, along with the
451 output of C<perl -V>, will be sent off to perlbug@perl.org to be
452 analysed by the Perl porting team.
453
454 If the bug you are reporting has security implications, which make it
455 inappropriate to send to a publicly archived mailing list, then please send
456 it to perl5-security-report@perl.org. This points to a closed subscription
457 unarchived mailing list, which includes
458 all the core committers, who will be able
459 to help assess the impact of issues, figure out a resolution, and help
460 co-ordinate the release of patches to mitigate or fix the problem across all
461 platforms on which Perl is supported. Please only use this address for
462 security issues in the Perl core, not for modules independently
463 distributed on CPAN.
464
465 =head1 SEE ALSO
466
467 The F<Changes> file for an explanation of how to view exhaustive details
468 on what changed.
469
470 The F<INSTALL> file for how to build Perl.
471
472 The F<README> file for general stuff.
473
474 The F<Artistic> and F<Copying> files for copyright information.
475
476 =cut