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