This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
ccca0973d5837bd20f0aa622ffd06037d670e5a2
[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.2
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.17.1 release and
13 the 5.17.2 release.
14
15 If you are upgrading from an earlier release such as 5.17.0, first read
16 L<perl5171delta>, which describes differences between 5.17.0 and
17 5.17.1.
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 =head1 Security
32
33 XXX Any security-related notices go here.  In particular, any security
34 vulnerabilities closed should be noted here rather than in the
35 L</Selected Bug Fixes> section.
36
37 [ List each security issue as a =head2 entry ]
38
39 =head1 Incompatible Changes
40
41 XXX For a release on a stable branch, this section aspires to be:
42
43     There are no changes intentionally incompatible with 5.XXX.XXX
44     If any exist, they are bugs, and we request that you submit a
45     report.  See L</Reporting Bugs> below.
46
47 [ List each incompatible change as a =head2 entry ]
48
49 =head1 Deprecations
50
51 XXX Any deprecated features, syntax, modules etc. should be listed here.
52 In particular, deprecated modules should be listed here even if they are
53 listed as an updated module in the L</Modules and Pragmata> section.
54
55 [ List each deprecation as a =head2 entry ]
56
57 =head1 Performance Enhancements
58
59 XXX Changes which enhance performance without changing behaviour go here. There
60 may well be none in a stable release.
61
62 [ List each enhancement as a =item entry ]
63
64 =over 4
65
66 =item *
67
68 XXX
69
70 =back
71
72 =head1 Modules and Pragmata
73
74 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
75 go here.  If Module::CoreList is updated, generate an initial draft of the
76 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
77 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
78 below.  A paragraph summary for important changes should then be added by hand.
79 In an ideal world, dual-life modules would have a F<Changes> file that could be
80 cribbed.
81
82 [ Within each section, list entries as a =item entry ]
83
84 =head2 New Modules and Pragmata
85
86 =over 4
87
88 =item *
89
90 XXX
91
92 =back
93
94 =head2 Updated Modules and Pragmata
95
96 =over 4
97
98 =item *
99
100 L<File::stat> has been upgraded from version 1.06 to 1.07.
101
102 Previously C<File::stat>'s overloaded C<-x> and C<-X> operators did not give
103 the correct results for directories or executable files when running as
104 root. They had been treating executable permissions for root just like for
105 any other user, performing group membership tests I<etc> for files not owned
106 by root. They now follow the correct Unix behaviour - for a directory they
107 are always true, and for a file if any of the three execute permission bits
108 are set then they report that root can execute the file. Perl's builtin
109 C<-x> and C<-X> operators have always been correct.
110
111 =item *
112
113 L<Tie::StdHandle> has been upgraded from version 4.2 to 4.3.
114
115 C<READ> now respects the offset argument to C<read> [perl #112826].
116
117 =back
118
119 =head2 Removed Modules and Pragmata
120
121 =over 4
122
123 =item *
124
125 XXX
126
127 =back
128
129 =head1 Documentation
130
131 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
132 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
133
134 =head2 New Documentation
135
136 XXX Changes which create B<new> files in F<pod/> go here.
137
138 =head3 L<XXX>
139
140 XXX Description of the purpose of the new file here
141
142 =head2 Changes to Existing Documentation
143
144 XXX Changes which significantly change existing files in F<pod/> go here.
145 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
146 section.
147
148 =head3 L<XXX>
149
150 =over 4
151
152 =item *
153
154 XXX Description of the change here
155
156 =back
157
158 =head1 Diagnostics
159
160 The following additions or changes have been made to diagnostic output,
161 including warnings and fatal error messages.  For the complete list of
162 diagnostic messages, see L<perldiag>.
163
164 XXX New or changed warnings emitted by the core's C<C> code go here. Also
165 include any changes in L<perldiag> that reconcile it to the C<C> code.
166
167 [ Within each section, list entries as a =item entry that links to perldiag,
168   e.g.
169
170   =item *
171
172   L<Invalid version object|perldiag/"Invalid version object">
173 ]
174
175 =head2 New Diagnostics
176
177 XXX Newly added diagnostic messages go here
178
179 =head3 New Errors
180
181 =over 4
182
183 =item *
184
185 L<Group name must start with a non-digit word character in regex; marked by <-- HERE in mE<sol>%sE<sol>|perldiag/"Group name must start with a non-digit word character in regex; marked by <-- HERE in m/%s/">
186
187 This error has been added for C<(?&0)>, which is invalid.  It used to
188 produce an incomprehensible error message [perl #101666].
189
190 =back
191
192 =head3 New Warnings
193
194 =over 4
195
196 =item *
197
198 C<chr()> now warns when passed a negative value [perl #83048].
199
200 =item *
201
202 C<srand()> now warns when passed a value that doesn't fit in a C<UV> (since the
203 value will be truncated rather than overflowing) [perl #40605].
204
205 =item *
206
207 Running perl with the C<-i> flag now warns if no input files are provided on
208 the command line [perl #113410].
209
210 =back
211
212 =head2 Changes to Existing Diagnostics
213
214 XXX Changes (i.e. rewording) of diagnostic messages go here
215
216 =over 4
217
218 =item *
219
220 XXX Describe change here
221
222 =back
223
224 =head1 Utility Changes
225
226 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
227 here. Most of these are built within the directories F<utils> and F<x2p>.
228
229 [ List utility changes as a =head3 entry for each utility and =item
230 entries for each change
231 Use L<XXX> with program names to get proper documentation linking. ]
232
233 =head3 L<XXX>
234
235 =over 4
236
237 =item *
238
239 XXX
240
241 =back
242
243 =head1 Configuration and Compilation
244
245 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
246 go here.  Any other changes to the Perl build process should be listed here.
247 However, any platform-specific changes should be listed in the
248 L</Platform Support> section, instead.
249
250 [ List changes as a =item entry ].
251
252 =over 4
253
254 =item *
255
256 Building perl with some Windows compilers used to fail due to a problem
257 with miniperl's C<glob> operator (which uses the C<perlglob> program)
258 deleting the PATH environment variable [perl #113798].
259
260 =item *
261
262 C<delete local> no longer crashes with certain magical arrays and hashes
263 [perl #112966].
264
265 =item *
266
267 C<local> on elements of certain magical arrays and hashes used not to
268 arrange to have the element deleted on scope exit, even if the element did
269 not exist before C<local>.
270
271 =item *
272
273 C<scalar(write)> no longer returns multiple items [perl #73690].
274
275 =item *
276
277 String to floating point conversions no longer misparse certain strings under
278 C<use locale> [perl #109318].
279
280 =item *
281
282 C<@INC> filters that die no longer leak memory [perl #92252].
283
284 =item *
285
286 The implementations of overloaded operations are now called in the correct
287 context. This allows, among other things, being able to properly override
288 C<< <> >> [perl #47119].
289
290 =item *
291
292 Specifying only the C<fallback> key when calling C<use overload> now behaves
293 properly [perl #113010].
294
295 =back
296
297 =head1 Testing
298
299 XXX Any significant changes to the testing of a freshly built perl should be
300 listed here.  Changes which create B<new> files in F<t/> go here as do any
301 large changes to the testing harness (e.g. when parallel testing was added).
302 Changes to existing files in F<t/> aren't worth summarising, although the bugs
303 that they represent may be covered elsewhere.
304
305 [ List each test improvement as a =item entry ]
306
307 =over 4
308
309 =item *
310
311 XXX
312
313 =back
314
315 =head1 Platform Support
316
317 XXX Any changes to platform support should be listed in the sections below.
318
319 [ Within the sections, list each platform as a =item entry with specific
320 changes as paragraphs below it. ]
321
322 =head2 New Platforms
323
324 XXX List any platforms that this version of perl compiles on, that previous
325 versions did not. These will either be enabled by new files in the F<hints/>
326 directories, or new subdirectories and F<README> files at the top level of the
327 source tree.
328
329 =over 4
330
331 =item *
332
333 Configure now always adds -qlanglvl=extc99 to the CC flags on AIX when
334 using xlC.  This will make it easier to compile a number of XS-based modules
335 that assume C99 [perl #113778].
336
337 =back
338
339 =head2 Discontinued Platforms
340
341 XXX List any platforms that this version of perl no longer compiles on.
342
343 =over 4
344
345 =item XXX-some-platform
346
347 XXX
348
349 =back
350
351 =head2 Platform-Specific Notes
352
353 XXX List any changes for specific platforms. This could include configuration
354 and compilation changes or changes in portability/compatibility.  However,
355 changes within modules for platforms should generally be listed in the
356 L</Modules and Pragmata> section.
357
358 =over 4
359
360 =item XXX-some-platform
361
362 XXX
363
364 =back
365
366 =head1 Internal Changes
367
368 XXX Changes which affect the interface available to C<XS> code go here.
369 Other significant internal changes for future core maintainers should
370 be noted as well.
371
372 [ List each change as a =item entry ]
373
374 =over 4
375
376 =item *
377
378 XXX
379
380 =back
381
382 =head1 Selected Bug Fixes
383
384 XXX Important bug fixes in the core language are summarised here.
385 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
386 L</Modules and Pragmata>.
387
388 [ List each fix as a =item entry ]
389
390 =over 4
391
392 =item *
393
394 A regression introduced in v5.14.0 has been fixed, in which some calls
395 to the C<re> module would clobber C<$_>.
396
397 =item *
398
399 C<do FILE> now always either sets or clears C<$@>, even when the file can't be
400 read. This ensures that testing C<$@> first (as recommended by the
401 documentation) always returns the correct result.
402
403 =item *
404
405 The array iterator used for the C<each @array> construct is now correctly
406 reset when C<@array> is cleared (RT #75596). This happens for example when the
407 array is globally assigned to, as in C<@array = (...)>, but not when its
408 B<values> are assigned to. In terms of the XS API, it means that C<av_clear()>
409 will now reset the iterator.
410
411 This mirrors the behaviour of the hash iterator when the hash is cleared.
412
413 =item *
414
415 C<< $class->can >>, C<< $class->isa >>, and C<< $class->DOES >> now return
416 correct results, regardless of whether that package referred to by C<$class>
417 exists [perl #47113].
418
419 =item *
420
421 Arriving signals no longer clear C<$@> [perl #45173].
422
423 =item *
424
425 Allow C<my ()> declarations with an empty variable list [perl #113554].
426
427 =item *
428
429 During parsing, subs declared after errors no longer leave stubs
430 [perl #113712].
431
432 =item *
433
434 Closures containing no string evals no longer hang on to their containing
435 subroutines, allowing variables closed over by outer subroutines to be
436 freed when the outer sub is freed, even if the inner sub still exists
437 [perl #89544].
438
439 =item *
440
441 Duplication of in-memory filehandles by opening with a "<&=" or ">&=" mode
442 stopped working properly in 5.16.0.  It was causing the new handle to
443 reference a different scalar variable.  This has been fixed [perl #113764].
444
445 =item *
446
447 C<qr//> expressions no longer crash with custom regular expression engines
448 that do not set C<offs> at regular expression compilation time
449 [perl #112962].
450
451 =back
452
453 =head1 Known Problems
454
455 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
456 tests that had to be C<TODO>ed for the release would be noted here. Unfixed
457 platform specific bugs also go here.
458
459 [ List each fix as a =item entry ]
460
461 =over 4
462
463 =item *
464
465 XXX
466
467 =back
468
469 =head1 Obituary
470
471 XXX If any significant core contributor has died, we've added a short obituary
472 here.
473
474 =head1 Acknowledgements
475
476 XXX Generate this with:
477
478   perl Porting/acknowledgements.pl v5.17.1..HEAD
479
480 =head1 Reporting Bugs
481
482 If you find what you think is a bug, you might check the articles
483 recently posted to the comp.lang.perl.misc newsgroup and the perl
484 bug database at http://rt.perl.org/perlbug/ .  There may also be
485 information at http://www.perl.org/ , the Perl Home Page.
486
487 If you believe you have an unreported bug, please run the L<perlbug>
488 program included with your release.  Be sure to trim your bug down
489 to a tiny but sufficient test case.  Your bug report, along with the
490 output of C<perl -V>, will be sent off to perlbug@perl.org to be
491 analysed by the Perl porting team.
492
493 If the bug you are reporting has security implications, which make it
494 inappropriate to send to a publicly archived mailing list, then please send
495 it to perl5-security-report@perl.org. This points to a closed subscription
496 unarchived mailing list, which includes
497 all the core committers, who will be able
498 to help assess the impact of issues, figure out a resolution, and help
499 co-ordinate the release of patches to mitigate or fix the problem across all
500 platforms on which Perl is supported. Please only use this address for
501 security issues in the Perl core, not for modules independently
502 distributed on CPAN.
503
504 =head1 SEE ALSO
505
506 The F<Changes> file for an explanation of how to view exhaustive details
507 on what changed.
508
509 The F<INSTALL> file for how to build Perl.
510
511 The F<README> file for general stuff.
512
513 The F<Artistic> and F<Copying> files for copyright information.
514
515 =cut