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