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