This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
1691022c36997a05a3207799d04c709e85617d69
[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 m/%s/|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 =back
206
207 =head2 Changes to Existing Diagnostics
208
209 XXX Changes (i.e. rewording) of diagnostic messages go here
210
211 =over 4
212
213 =item *
214
215 XXX Describe change here
216
217 =back
218
219 =head1 Utility Changes
220
221 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
222 here. Most of these are built within the directories F<utils> and F<x2p>.
223
224 [ List utility changes as a =head3 entry for each utility and =item
225 entries for each change
226 Use L<XXX> with program names to get proper documentation linking. ]
227
228 =head3 L<XXX>
229
230 =over 4
231
232 =item *
233
234 XXX
235
236 =back
237
238 =head1 Configuration and Compilation
239
240 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
241 go here.  Any other changes to the Perl build process should be listed here.
242 However, any platform-specific changes should be listed in the
243 L</Platform Support> section, instead.
244
245 [ List changes as a =item entry ].
246
247 =over 4
248
249 =item *
250
251 XXX
252
253 =back
254
255 =head1 Testing
256
257 XXX Any significant changes to the testing of a freshly built perl should be
258 listed here.  Changes which create B<new> files in F<t/> go here as do any
259 large changes to the testing harness (e.g. when parallel testing was added).
260 Changes to existing files in F<t/> aren't worth summarising, although the bugs
261 that they represent may be covered elsewhere.
262
263 [ List each test improvement as a =item entry ]
264
265 =over 4
266
267 =item *
268
269 XXX
270
271 =back
272
273 =head1 Platform Support
274
275 XXX Any changes to platform support should be listed in the sections below.
276
277 [ Within the sections, list each platform as a =item entry with specific
278 changes as paragraphs below it. ]
279
280 =head2 New Platforms
281
282 XXX List any platforms that this version of perl compiles on, that previous
283 versions did not. These will either be enabled by new files in the F<hints/>
284 directories, or new subdirectories and F<README> files at the top level of the
285 source tree.
286
287 =over 4
288
289 =item XXX-some-platform
290
291 XXX
292
293 =back
294
295 =head2 Discontinued Platforms
296
297 XXX List any platforms that this version of perl no longer compiles on.
298
299 =over 4
300
301 =item XXX-some-platform
302
303 XXX
304
305 =back
306
307 =head2 Platform-Specific Notes
308
309 XXX List any changes for specific platforms. This could include configuration
310 and compilation changes or changes in portability/compatibility.  However,
311 changes within modules for platforms should generally be listed in the
312 L</Modules and Pragmata> section.
313
314 =over 4
315
316 =item XXX-some-platform
317
318 XXX
319
320 =back
321
322 =head1 Internal Changes
323
324 XXX Changes which affect the interface available to C<XS> code go here.
325 Other significant internal changes for future core maintainers should
326 be noted as well.
327
328 [ List each change as a =item entry ]
329
330 =over 4
331
332 =item *
333
334 XXX
335
336 =back
337
338 =head1 Selected Bug Fixes
339
340 XXX Important bug fixes in the core language are summarised here.
341 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
342 L</Modules and Pragmata>.
343
344 [ List each fix as a =item entry ]
345
346 =over 4
347
348 =item *
349
350 A regression introduced in v5.14.0 has been fixed, in which some calls
351 to the C<re> module would clobber C<$_>.
352
353 =item *
354
355 C<do FILE> now always either sets or clears C<$@>, even when the file can't be
356 read. This ensures that testing C<$@> first (as recommended by the
357 documentation) always returns the correct result.
358
359 =item *
360
361 The array iterator used for the C<each @array> construct is now correctly
362 reset when C<@array> is cleared (RT #75596). This happens for example when the
363 array is globally assigned to, as in C<@array = (...)>, but not when its
364 B<values> are assigned to. In terms of the XS API, it means that C<av_clear()>
365 will now reset the iterator.
366
367 This mirrors the behaviour of the hash iterator when the hash is cleared.
368
369 =item *
370
371 C<< $class->can >>, C<< $class->isa >>, and C<< $class->DOES >> now return
372 correct results, regardless of whether that package referred to by C<$class>
373 exists [perl #47113].
374
375 =item *
376
377 Arriving signals no longer clear C<$@> [perl #45173].
378
379 =item *
380
381 Allow C<my ()> declarations with an empty variable list [perl #113554].
382
383 =item *
384
385 During parsing, subs declared after errors no longer leave stubs
386 [perl #113712].
387
388 =item *
389
390 Closures containing no string evals no longer hang on to their containing
391 subroutines, allowing variables closed over by outer subroutines to be
392 freed when the outer sub is freed, even if the inner sub still exists
393 [perl #89544].
394
395 =item *
396
397 Duplication of in-memory filehandles by opening with a "<&=" or ">&=" mode
398 stopped working properly in 5.16.0.  It was causing the new handle to
399 reference a different scalar variable.  This has been fixed [perl #113764].
400
401 =item *
402
403 C<qr//> expressions no longer crash with custom regular expression engines
404 that do not set C<offs> at regular expression compilation time
405 [perl #112962].
406
407 =back
408
409 =head1 Known Problems
410
411 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
412 tests that had to be C<TODO>ed for the release would be noted here. Unfixed
413 platform specific bugs also go here.
414
415 [ List each fix as a =item entry ]
416
417 =over 4
418
419 =item *
420
421 XXX
422
423 =back
424
425 =head1 Obituary
426
427 XXX If any significant core contributor has died, we've added a short obituary
428 here.
429
430 =head1 Acknowledgements
431
432 XXX Generate this with:
433
434   perl Porting/acknowledgements.pl v5.17.1..HEAD
435
436 =head1 Reporting Bugs
437
438 If you find what you think is a bug, you might check the articles
439 recently posted to the comp.lang.perl.misc newsgroup and the perl
440 bug database at http://rt.perl.org/perlbug/ .  There may also be
441 information at http://www.perl.org/ , the Perl Home Page.
442
443 If you believe you have an unreported bug, please run the L<perlbug>
444 program included with your release.  Be sure to trim your bug down
445 to a tiny but sufficient test case.  Your bug report, along with the
446 output of C<perl -V>, will be sent off to perlbug@perl.org to be
447 analysed by the Perl porting team.
448
449 If the bug you are reporting has security implications, which make it
450 inappropriate to send to a publicly archived mailing list, then please send
451 it to perl5-security-report@perl.org. This points to a closed subscription
452 unarchived mailing list, which includes
453 all the core committers, who will be able
454 to help assess the impact of issues, figure out a resolution, and help
455 co-ordinate the release of patches to mitigate or fix the problem across all
456 platforms on which Perl is supported. Please only use this address for
457 security issues in the Perl core, not for modules independently
458 distributed on CPAN.
459
460 =head1 SEE ALSO
461
462 The F<Changes> file for an explanation of how to view exhaustive details
463 on what changed.
464
465 The F<INSTALL> file for how to build Perl.
466
467 The F<README> file for general stuff.
468
469 The F<Artistic> and F<Copying> files for copyright information.
470
471 =cut