This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
(perl #134125) accept only complete hex and binary literals
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
8424e368
S
5[ this is a template for a new perldelta file. Any text flagged as XXX needs
6to be processed before release. ]
7
8perldelta - what is new for perl v5.31.1
d407e309 9
862f380b 10=head1 DESCRIPTION
261e14b0 11
8424e368 12This document describes differences between the 5.31.0 release and the 5.31.1
862f380b 13release.
261e14b0 14
8424e368
S
15If you are upgrading from an earlier release such as 5.30.0, first read
16L<perl5310delta>, which describes differences between 5.30.0 and 5.31.0.
17
18=head1 Notice
19
20XXX Any important notices here
21
22=head1 Core Enhancements
23
24XXX New core language features go here. Summarize user-visible core language
25enhancements. Particularly prominent performance optimisations could go
26here, but most should go in the L</Performance Enhancements> section.
27
28[ List each enhancement as a =head2 entry ]
29
30=head1 Security
31
32XXX Any security-related notices go here. In particular, any security
33vulnerabilities closed should be noted here rather than in the
34L</Selected Bug Fixes> section.
35
36[ List each security issue as a =head2 entry ]
37
38=head1 Incompatible Changes
39
40XXX 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
50XXX Any deprecated features, syntax, modules etc. should be listed here.
51
52=head2 Module removals
53
54XXX Remove this section if not applicable.
55
56The following modules will be removed from the core distribution in a
57future release, and will at that time need to be installed from CPAN.
58Distributions on CPAN which require these modules will need to list them as
59prerequisites.
60
61The core versions of these modules will now issue C<"deprecated">-category
62warnings to alert you to this fact. To silence these deprecation warnings,
63install the modules in question from CPAN.
64
65Note that these are (with rare exceptions) fine modules that you are encouraged
66to continue to use. Their disinclusion from core primarily hinges on their
67necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
68not usually on concerns over their design.
69
70=over
71
72=item XXX
73
74XXX Note that deprecated modules should be listed here even if they are listed
75as 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
83XXX Changes which enhance performance without changing behaviour go here.
84There may well be none in a stable release.
85
86[ List each enhancement as an =item entry ]
87
88=over 4
89
90=item *
91
92XXX
93
94=back
261e14b0 95
862f380b 96=head1 Modules and Pragmata
d407e309 97
8424e368
S
98XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
99go here. If Module::CoreList is updated, generate an initial draft of the
100following sections using F<Porting/corelist-perldelta.pl>. A paragraph summary
101for important changes should then be added by hand. In an ideal world,
102dual-life modules would have a F<Changes> file that could be cribbed.
103
104The list of new and updated modules is modified automatically as part of
105preparing a Perl release, so the only reason to manually add entries here is if
106you're summarising the important changes in the module update. (Also, if the
107manually-added details don't match the automatically-generated ones, the
108release manager will have to investigate the situation carefully.)
109
110[ Within each section, list entries as an =item entry ]
111
112=head2 New Modules and Pragmata
113
114=over 4
115
116=item *
117
118XXX Remove this section if not applicable.
119
120=back
121
862f380b 122=head2 Updated Modules and Pragmata
7b97bf55 123
ab6f2e91 124=over 4
7b97bf55 125
9409f532 126=item *
7b97bf55 127
a04f48a5 128L<Storable> has been upgraded from version 3.15 to 3.16.
8424e368 129
a04f48a5
TC
130Regular expressions objects weren't properly counted for object id
131purposes on retrieve. This would corrupt the resulting structure, or
132cause a runtime error in some cases. [perl #134179]
8424e368
S
133
134=back
135
136=head2 Removed Modules and Pragmata
137
138=over 4
139
140=item *
141
c57372c9
KW
142Pod::Parser has been removed from the core distribution.
143It still is available for download from CPAN. This resolves [perl
144#119439].
8424e368
S
145
146=back
147
148=head1 Documentation
149
150XXX Changes to files in F<pod/> go here. Consider grouping entries by
151file and be sure to link to the appropriate page, e.g. L<perlfunc>.
152
153=head2 New Documentation
154
155XXX Changes which create B<new> files in F<pod/> go here.
156
157=head3 L<XXX>
158
159XXX Description of the purpose of the new file here
160
161=head2 Changes to Existing Documentation
162
163We have attempted to update the documentation to reflect the changes
164listed in this document. If you find any we have missed, send email
165to L<perlbug@perl.org|mailto:perlbug@perl.org>.
166
167XXX Changes which significantly change existing files in F<pod/> go here.
168However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
169section.
170
171Additionally, the following selected changes have been made:
172
173=head3 L<XXX>
174
175=over 4
d407e309 176
d407e309
S
177=item *
178
8424e368
S
179XXX Description of the change here
180
181=back
182
183=head1 Diagnostics
184
185The following additions or changes have been made to diagnostic output,
186including warnings and fatal error messages. For the complete list of
187diagnostic messages, see L<perldiag>.
188
189XXX New or changed warnings emitted by the core's C<C> code go here. Also
190include any changes in L<perldiag> that reconcile it to the C<C> code.
191
192=head2 New Diagnostics
193
194XXX Newly added diagnostic messages go under here, separated into New Errors
195and New Warnings
196
197=head3 New Errors
198
199=over 4
d407e309
S
200
201=item *
202
8424e368 203XXX L<message|perldiag/"message">
d407e309 204
862f380b 205=back
d407e309 206
8424e368
S
207=head3 New Warnings
208
209=over 4
210
211=item *
212
213XXX L<message|perldiag/"message">
214
215=back
216
217=head2 Changes to Existing Diagnostics
218
219XXX Changes (i.e. rewording) of diagnostic messages go here
220
221=over 4
222
223=item *
224
225XXX Describe change here
226
227=back
228
229=head1 Utility Changes
230
231XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
232Most of these are built within the directory F<utils>.
233
234[ List utility changes as a =head2 entry for each utility and =item
235entries for each change
236Use L<XXX> with program names to get proper documentation linking. ]
237
238=head2 L<XXX>
239
240=over 4
241
242=item *
243
244XXX
245
246=back
247
248=head1 Configuration and Compilation
249
250XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
251go here. Any other changes to the Perl build process should be listed here.
252However, any platform-specific changes should be listed in the
253L</Platform Support> section, instead.
254
255[ List changes as an =item entry ].
256
257=over 4
258
259=item *
260
261XXX
262
263=back
264
265=head1 Testing
266
267XXX Any significant changes to the testing of a freshly built perl should be
268listed here. Changes which create B<new> files in F<t/> go here as do any
269large changes to the testing harness (e.g. when parallel testing was added).
270Changes to existing files in F<t/> aren't worth summarizing, although the bugs
271that they represent may be covered elsewhere.
272
273XXX If there were no significant test changes, say this:
274
275Tests were added and changed to reflect the other additions and changes
276in this release.
277
278XXX If instead there were significant changes, say this:
279
280Tests were added and changed to reflect the other additions and
281changes in this release. Furthermore, these significant changes were
282made:
283
284[ List each test improvement as an =item entry ]
285
286=over 4
287
288=item *
289
290XXX
291
292=back
293
294=head1 Platform Support
295
296XXX Any changes to platform support should be listed in the sections below.
297
298[ Within the sections, list each platform as an =item entry with specific
299changes as paragraphs below it. ]
300
301=head2 New Platforms
302
303XXX List any platforms that this version of perl compiles on, that previous
304versions did not. These will either be enabled by new files in the F<hints/>
305directories, or new subdirectories and F<README> files at the top level of the
306source tree.
307
308=over 4
309
310=item XXX-some-platform
311
312XXX
313
314=back
315
316=head2 Discontinued Platforms
317
318XXX List any platforms that this version of perl no longer compiles on.
319
320=over 4
321
322=item XXX-some-platform
323
324XXX
325
326=back
327
328=head2 Platform-Specific Notes
329
330XXX List any changes for specific platforms. This could include configuration
331and compilation changes or changes in portability/compatibility. However,
332changes within modules for platforms should generally be listed in the
333L</Modules and Pragmata> section.
334
335=over 4
336
337=item XXX-some-platform
338
339XXX
340
341=back
342
343=head1 Internal Changes
344
345XXX Changes which affect the interface available to C<XS> code go here. Other
346significant internal changes for future core maintainers should be noted as
347well.
348
349[ List each change as an =item entry ]
350
351=over 4
352
353=item *
354
fb55ce6b
TC
355L<eval_pv()|perlapi/eval_pv> no longer stringifies the exception when
356C<croak_on_error> is true. [perl #134175]
8424e368
S
357
358=back
359
360=head1 Selected Bug Fixes
361
362XXX Important bug fixes in the core language are summarized here. Bug fixes in
363files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
364
365[ List each fix as an =item entry ]
366
367=over 4
368
369=item *
370
fd0b39e2
TC
371close() on a pipe now preemptively clears the PerlIO object from the
372IO SV. This prevents a second attempt to close the already closed
373PerlIO object if a signal handler calls die() or exit() while close()
374is waiting for the child process to complete. [perl #122112]
8424e368 375
ddf10889
TC
376=item *
377
378C<< sprintf("%.*a", -10000, $x) >> would cause a buffer overflow due
379to mishandling of the negative precision value. [perl #134008]
380
755e4cab
TC
381=item *
382
383scalar() on a reference could cause an erroneous assertion failure
384during compilation. [perl #134045]
385
fef47ada
TC
386=item *
387
388Extraordinarily large (over 2GB) floating point format widths could
389cause an integer overflow in the underlying call to snprintf(),
390resulting in an assertion. Formatted floating point widths are now
391limited to the range of int, the return value of snprintf(). [perl
392#133913]
393
4ec3954c
TC
394=item *
395
396Parsing the following constructs within a sub-parse (such as with
397C<"${code here}"> or C<s/.../code here/e>) has changed to match how
398they're parsed normally:
399
400=over
401
402=item *
403
404C<print $fh ...> no longer produces a syntax error.
405
406=item *
407
408Code like C<s/.../ ${time} /e> now properly produces an "Ambiguous use
409of ${time} resolved to $time at ..." warning when warnings are enabled.
410
411=item *
412
413C<@x {"a"}> (with the space) in a sub-parse now properly produces a
414"better written as" warning when warnings are enabled.
415
416=item *
417
418attributes can now be used in a sub-parse.
419
420=back
421
422[perl #133850]
423
8424e368
S
424=back
425
426=head1 Known Problems
427
428XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
429tests that had to be C<TODO>ed for the release would be noted here. Unfixed
430platform specific bugs also go here.
431
432[ List each fix as an =item entry ]
433
434=over 4
435
436=item *
437
438XXX
439
440=back
441
442=head1 Errata From Previous Releases
443
444=over 4
445
446=item *
447
448XXX Add anything here that we forgot to add, or were mistaken about, in
449the perldelta of a previous release.
450
451=back
452
453=head1 Obituary
454
455XXX If any significant core contributor or member of the CPAN community has
456died, add a short obituary here.
457
458=head1 Acknowledgements
459
460XXX Generate this with:
461
462 perl Porting/acknowledgements.pl v5.31.0..HEAD
463
44691e6f
AB
464=head1 Reporting Bugs
465
373fec1e 466If you find what you think is a bug, you might check the perl bug database
15f62f05
KE
467at L<https://rt.perl.org/>. There may also be information at
468L<http://www.perl.org/>, the Perl Home Page.
44691e6f 469
e08634c5
SH
470If you believe you have an unreported bug, please run the L<perlbug> program
471included with your release. Be sure to trim your bug down to a tiny but
472sufficient test case. Your bug report, along with the output of C<perl -V>,
0e18d1c4 473will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f 474
87c118b9
DM
475If the bug you are reporting has security implications which make it
476inappropriate to send to a publicly archived mailing list, then see
373fec1e
SH
477L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
478for details of how to report the issue.
44691e6f 479
390ae6f9
S
480=head1 Give Thanks
481
373fec1e
SH
482If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
483you can do so by running the C<perlthanks> program:
390ae6f9
S
484
485 perlthanks
486
487This will send an email to the Perl 5 Porters list with your show of thanks.
488
44691e6f
AB
489=head1 SEE ALSO
490
e08634c5
SH
491The F<Changes> file for an explanation of how to view exhaustive details on
492what changed.
44691e6f
AB
493
494The F<INSTALL> file for how to build Perl.
495
496The F<README> file for general stuff.
497
498The F<Artistic> and F<Copying> files for copyright information.
499
500=cut