This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Correct a perldelta entry
[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 XXX needs
6 to be processed before release. ]
7
8 perldelta - what is new for perl v5.25.4
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.25.3 release and the 5.25.4
13 release.
14
15 If you are upgrading from an earlier release such as 5.25.2, first read
16 L<perl5253delta>, which describes differences between 5.25.2 and 5.25.3.
17
18 =head1 Notice
19
20 XXX Any important notices here
21
22 =head1 Core Enhancements
23
24 XXX New core language features go here.  Summarize user-visible core language
25 enhancements.  Particularly prominent performance optimisations could go
26 here, but most should go in the L</Performance Enhancements> section.
27
28 [ List each enhancement as a =head2 entry ]
29
30 =head1 Security
31
32 XXX Any security-related notices go here.  In particular, any security
33 vulnerabilities closed should be noted here rather than in the
34 L</Selected Bug Fixes> section.
35
36 [ List each security issue as a =head2 entry ]
37
38 =head1 Incompatible Changes
39
40 XXX For a release on a stable branch, this section aspires to be:
41
42     There are no changes intentionally incompatible with 5.XXX.XXX
43     If any exist, they are bugs, and we request that you submit a
44     report.  See L</Reporting Bugs> below.
45
46 [ List each incompatible change as a =head2 entry ]
47
48 =head1 Deprecations
49
50 XXX Any deprecated features, syntax, modules etc. should be listed here.
51
52 =head2 Module removals
53
54 XXX Remove this section if inapplicable.
55
56 The following modules will be removed from the core distribution in a
57 future release, and will at that time need to be installed from CPAN.
58 Distributions on CPAN which require these modules will need to list them as
59 prerequisites.
60
61 The core versions of these modules will now issue C<"deprecated">-category
62 warnings to alert you to this fact.  To silence these deprecation warnings,
63 install the modules in question from CPAN.
64
65 Note that these are (with rare exceptions) fine modules that you are encouraged
66 to continue to use.  Their disinclusion from core primarily hinges on their
67 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
68 not usually on concerns over their design.
69
70 =over
71
72 =item XXX
73
74 XXX Note that deprecated modules should be listed here even if they are listed
75 as an updated module in the L</Modules and Pragmata> section.
76
77 =back
78
79 [ List each other deprecation as a =head2 entry ]
80
81 =head1 Performance Enhancements
82
83 XXX Changes which enhance performance without changing behaviour go here.
84 There may well be none in a stable release.
85
86 [ List each enhancement as a =item entry ]
87
88 =over 4
89
90 =item *
91
92 The rather slow implementation for the experimental subroutine signatures
93 feature has been made much faster; it is now comparable in speed with the
94 old-style C<my ($a, $b, @c) = @_>.
95
96 =back
97
98 =head1 Modules and Pragmata
99
100 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
101 go here.  If Module::CoreList is updated, generate an initial draft of the
102 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
103 for important changes should then be added by hand.  In an ideal world,
104 dual-life modules would have a F<Changes> file that could be cribbed.
105
106 [ Within each section, list entries as a =item entry ]
107
108 =head2 New Modules and Pragmata
109
110 =over 4
111
112 =item *
113
114 XXX
115
116 =back
117
118 =head2 Updated Modules and Pragmata
119
120 =over 4
121
122 =item *
123
124 L<XXX> has been upgraded from version A.xx to B.yy.
125
126 =item *
127
128 L<NEXT> has been upgraded from version 0.65 to 0.67.
129
130 =back
131
132 =head2 Removed Modules and Pragmata
133
134 =over 4
135
136 =item *
137
138 XXX
139
140 =back
141
142 =head1 Documentation
143
144 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
145 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
146
147 =head2 New Documentation
148
149 XXX Changes which create B<new> files in F<pod/> go here.
150
151 =head3 L<XXX>
152
153 XXX Description of the purpose of the new file here
154
155 =head2 Changes to Existing Documentation
156
157 XXX Changes which significantly change existing files in F<pod/> go here.
158 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
159 section.
160
161 =head3 L<XXX>
162
163 =over 4
164
165 =item *
166
167 XXX Description of the change here
168
169 =back
170
171 =head1 Diagnostics
172
173 The following additions or changes have been made to diagnostic output,
174 including warnings and fatal error messages.  For the complete list of
175 diagnostic messages, see L<perldiag>.
176
177 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
178 include any changes in L<perldiag> that reconcile it to the C<C> code.
179
180 =head2 New Diagnostics
181
182 XXX Newly added diagnostic messages go under here, separated into New Errors
183 and New Warnings
184
185 =head3 New Errors
186
187 =over 4
188
189 =item *
190
191 XXX L<message|perldiag/"message">
192
193 =back
194
195 =head3 New Warnings
196
197 =over 4
198
199 =item *
200
201 XXX L<message|perldiag/"message">
202
203 =back
204
205 =head2 Changes to Existing Diagnostics
206
207 XXX Changes (i.e. rewording) of diagnostic messages go here
208
209 =over 4
210
211 =item *
212
213 XXX Describe change here
214
215 =back
216
217 =head1 Utility Changes
218
219 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
220 Most of these are built within the directory F<utils>.
221
222 [ List utility changes as a =head2 entry for each utility and =item
223 entries for each change
224 Use L<XXX> with program names to get proper documentation linking. ]
225
226 =head2 L<XXX>
227
228 =over 4
229
230 =item *
231
232 XXX
233
234 =back
235
236 =head1 Configuration and Compilation
237
238 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
239 go here.  Any other changes to the Perl build process should be listed here.
240 However, any platform-specific changes should be listed in the
241 L</Platform Support> section, instead.
242
243 [ List changes as a =item entry ].
244
245 =over 4
246
247 =item *
248
249 XXX
250
251 =back
252
253 =head1 Testing
254
255 XXX Any significant changes to the testing of a freshly built perl should be
256 listed here.  Changes which create B<new> files in F<t/> go here as do any
257 large changes to the testing harness (e.g. when parallel testing was added).
258 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
259 that they represent may be covered elsewhere.
260
261 [ List each test improvement as a =item entry ]
262
263 =over 4
264
265 =item *
266
267 XXX
268
269 =back
270
271 =head1 Platform Support
272
273 XXX Any changes to platform support should be listed in the sections below.
274
275 [ Within the sections, list each platform as a =item entry with specific
276 changes as paragraphs below it. ]
277
278 =head2 New Platforms
279
280 XXX List any platforms that this version of perl compiles on, that previous
281 versions did not.  These will either be enabled by new files in the F<hints/>
282 directories, or new subdirectories and F<README> files at the top level of the
283 source tree.
284
285 =over 4
286
287 =item XXX-some-platform
288
289 XXX
290
291 =back
292
293 =head2 Discontinued Platforms
294
295 XXX List any platforms that this version of perl no longer compiles on.
296
297 =over 4
298
299 =item XXX-some-platform
300
301 XXX
302
303 =back
304
305 =head2 Platform-Specific Notes
306
307 XXX List any changes for specific platforms.  This could include configuration
308 and compilation changes or changes in portability/compatibility.  However,
309 changes within modules for platforms should generally be listed in the
310 L</Modules and Pragmata> section.
311
312 =over 4
313
314 =item XXX-some-platform
315
316 XXX
317
318 =back
319
320 =head1 Internal Changes
321
322 XXX Changes which affect the interface available to C<XS> code go here.  Other
323 significant internal changes for future core maintainers should be noted as
324 well.
325
326 [ List each change as a =item entry ]
327
328 =over 4
329
330 =item *
331
332 Three new ops, C<OP_ARGELEM>, C<OP_ARGDEFELEM> and C<OP_ARGCHECK> have
333 been added. These are intended principally to implement the individual
334 elements of a subroutine signature, plus any overall checking required.
335
336 =back
337
338 =head1 Selected Bug Fixes
339
340 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
341 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
342
343 [ List each fix as a =item entry ]
344
345 =over 4
346
347 =item *
348
349 Problems with in-place array sorts: code like C<@a = sort { ... } @a>,
350 where the source and destination of the sort are the same plain array, are
351 optimised to do less copying around. Two side-effects of this optimisation
352 were that the contents of C<@a> as visible to to sort routine were
353 partially sorted, and under some circumstances accessing C<@a> during the
354 sort could crash the interpreter. Both these issues have been fixed, and
355 Sort functions see the original value of C<@a>.
356
357 =item *
358
359 Non-ASCII string delimiters are now reported correctly in error messages
360 for unterminated strings.  [perl #128701]
361
362 =item *
363
364 C<pack("p", ...)> used to emit its warning ("Attempt to pack pointer to
365 temporary value") erroneously in some cases, but has been fixed.
366
367 =item *
368
369 C<@DB::args> is now exempt from "used once" warnings.  The warnings only
370 occurred under B<-w>, because F<warnings.pm> itself uses C<@DB::args>
371 multiple times.
372
373 =item *
374
375 The use of built-in arrays or hash slices in a double-quoted string no
376 longer issues a warning ("Possible unintended interpolation...") if the
377 variable has not been mentioned before.  This affected code like
378 C<qq|@DB::args|> and C<qq|@SIG{'CHLD', 'HUP'}|>.  (The special variables
379 C<@-> and C<@+> were already exempt from the warning.)
380
381 =item *
382
383 C<gethostent> and similar functions now perform a null check internally, to
384 avoid crashing with torsocks.  This was a regression from 5.22.  [perl
385 #128740]
386
387 =item *
388
389 C<defined *{'!'}>, C<defined *{'['}>, and C<defined *{'-'}> no longer leak
390 memory if the typeglob in question has never been accessed before.
391
392 =item *
393
394 In 5.25.4 fchown() was changed not to accept negative one as an argument
395 because in some platforms that is an error.  However, in some other platforms
396 that is an acceptable argument.  This change has been reverted [perl #128967].
397
398 =item *
399
400 Mentioning the same constant twice in a row (which is a syntax error) no
401 longer fails an assertion under debugging builds.  This was a regression
402 from 5.20.  [perl #126482]
403
404 =item *
405
406 Many issues relating to C<printf "%a"> of hexadecimal floating point
407 were fixed.  In addition, the "subnormals" (formerly known as "denormals")
408 floating point anumbers are now supported both with the plain IEEE 754
409 floating point numbers (64-bit or 128-bit) and the x86 80-bit
410 "extended precision".  Note that subnormal hexadecimal floating
411 point literals will give a warning about "exponent underflow".
412 [perl #128843, #128889, #128890, #128893, #128909, #128919]
413
414 =item *
415
416 A regression in 5.24 with C<tr/\N{U+...}/foo/> when the code point was between
417 128 and 255 has been fixed. [perl #128734].
418
419 =item *
420
421 A regression from the previous development release, 5.23.3, where
422 compiling a regular expression could crash the interpreter has been
423 fixed. [perl #128686].
424
425 =item *
426
427 Use of a string delimiter whose code point is above 2**31 now works
428 correctly on platforms that allow this.  Previously, certain characters,
429 due to truncation, would be confused with other delimiter characters
430 with special meaning (such as C<?> in C<m?...?>), resulting
431 in inconsistent behaviour.  Note that this is non-portable,
432 and is based on Perl's extension to UTF-8, and is probably not
433 displayable nor enterable by any editor. [perl #128738]
434
435 =back
436
437 =head1 Known Problems
438
439 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
440 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
441 platform specific bugs also go here.
442
443 [ List each fix as a =item entry ]
444
445 =over 4
446
447 =item *
448
449 XXX
450
451 =back
452
453 =head1 Errata From Previous Releases
454
455 =over 4
456
457 =item *
458
459 XXX Add anything here that we forgot to add, or were mistaken about, in
460 the perldelta of a previous release.
461
462 =back
463
464 =head1 Obituary
465
466 XXX If any significant core contributor has died, we've added a short obituary
467 here.
468
469 =head1 Acknowledgements
470
471 XXX Generate this with:
472
473   perl Porting/acknowledgements.pl v5.25.3..HEAD
474
475 =head1 Reporting Bugs
476
477 If you find what you think is a bug, you might check the perl bug database
478 at L<https://rt.perl.org/> .  There may also be information at
479 L<http://www.perl.org/> , the Perl Home Page.
480
481 If you believe you have an unreported bug, please run the L<perlbug> program
482 included with your release.  Be sure to trim your bug down to a tiny but
483 sufficient test case.  Your bug report, along with the output of C<perl -V>,
484 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
485
486 If the bug you are reporting has security implications which make it
487 inappropriate to send to a publicly archived mailing list, then see
488 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
489 for details of how to report the issue.
490
491 =head1 SEE ALSO
492
493 The F<Changes> file for an explanation of how to view exhaustive details on
494 what changed.
495
496 The F<INSTALL> file for how to build Perl.
497
498 The F<README> file for general stuff.
499
500 The F<Artistic> and F<Copying> files for copyright information.
501
502 =cut