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