This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for 0f4fe36327e6, 1768639d6db2
[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
8424e368
S
128L<XXX> has been upgraded from version A.xx to B.yy.
129
130If there was something important to note about this change, include that here.
131
132=back
133
134=head2 Removed Modules and Pragmata
135
136=over 4
137
138=item *
139
c57372c9
KW
140Pod::Parser has been removed from the core distribution.
141It still is available for download from CPAN. This resolves [perl
142#119439].
8424e368
S
143
144=back
145
146=head1 Documentation
147
148XXX Changes to files in F<pod/> go here. Consider grouping entries by
149file and be sure to link to the appropriate page, e.g. L<perlfunc>.
150
151=head2 New Documentation
152
153XXX Changes which create B<new> files in F<pod/> go here.
154
155=head3 L<XXX>
156
157XXX Description of the purpose of the new file here
158
159=head2 Changes to Existing Documentation
160
161We have attempted to update the documentation to reflect the changes
162listed in this document. If you find any we have missed, send email
163to L<perlbug@perl.org|mailto:perlbug@perl.org>.
164
165XXX Changes which significantly change existing files in F<pod/> go here.
166However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
167section.
168
169Additionally, the following selected changes have been made:
170
171=head3 L<XXX>
172
173=over 4
d407e309 174
d407e309
S
175=item *
176
8424e368
S
177XXX Description of the change here
178
179=back
180
181=head1 Diagnostics
182
183The following additions or changes have been made to diagnostic output,
184including warnings and fatal error messages. For the complete list of
185diagnostic messages, see L<perldiag>.
186
187XXX New or changed warnings emitted by the core's C<C> code go here. Also
188include any changes in L<perldiag> that reconcile it to the C<C> code.
189
190=head2 New Diagnostics
191
192XXX Newly added diagnostic messages go under here, separated into New Errors
193and New Warnings
194
195=head3 New Errors
196
197=over 4
d407e309
S
198
199=item *
200
8424e368 201XXX L<message|perldiag/"message">
d407e309 202
862f380b 203=back
d407e309 204
8424e368
S
205=head3 New Warnings
206
207=over 4
208
209=item *
210
211XXX L<message|perldiag/"message">
212
213=back
214
215=head2 Changes to Existing Diagnostics
216
217XXX Changes (i.e. rewording) of diagnostic messages go here
218
219=over 4
220
221=item *
222
223XXX Describe change here
224
225=back
226
227=head1 Utility Changes
228
229XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
230Most of these are built within the directory F<utils>.
231
232[ List utility changes as a =head2 entry for each utility and =item
233entries for each change
234Use L<XXX> with program names to get proper documentation linking. ]
235
236=head2 L<XXX>
237
238=over 4
239
240=item *
241
242XXX
243
244=back
245
246=head1 Configuration and Compilation
247
248XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
249go here. Any other changes to the Perl build process should be listed here.
250However, any platform-specific changes should be listed in the
251L</Platform Support> section, instead.
252
253[ List changes as an =item entry ].
254
255=over 4
256
257=item *
258
259XXX
260
261=back
262
263=head1 Testing
264
265XXX Any significant changes to the testing of a freshly built perl should be
266listed here. Changes which create B<new> files in F<t/> go here as do any
267large changes to the testing harness (e.g. when parallel testing was added).
268Changes to existing files in F<t/> aren't worth summarizing, although the bugs
269that they represent may be covered elsewhere.
270
271XXX If there were no significant test changes, say this:
272
273Tests were added and changed to reflect the other additions and changes
274in this release.
275
276XXX If instead there were significant changes, say this:
277
278Tests were added and changed to reflect the other additions and
279changes in this release. Furthermore, these significant changes were
280made:
281
282[ List each test improvement as an =item entry ]
283
284=over 4
285
286=item *
287
288XXX
289
290=back
291
292=head1 Platform Support
293
294XXX Any changes to platform support should be listed in the sections below.
295
296[ Within the sections, list each platform as an =item entry with specific
297changes as paragraphs below it. ]
298
299=head2 New Platforms
300
301XXX List any platforms that this version of perl compiles on, that previous
302versions did not. These will either be enabled by new files in the F<hints/>
303directories, or new subdirectories and F<README> files at the top level of the
304source tree.
305
306=over 4
307
308=item XXX-some-platform
309
310XXX
311
312=back
313
314=head2 Discontinued Platforms
315
316XXX List any platforms that this version of perl no longer compiles on.
317
318=over 4
319
320=item XXX-some-platform
321
322XXX
323
324=back
325
326=head2 Platform-Specific Notes
327
328XXX List any changes for specific platforms. This could include configuration
329and compilation changes or changes in portability/compatibility. However,
330changes within modules for platforms should generally be listed in the
331L</Modules and Pragmata> section.
332
333=over 4
334
335=item XXX-some-platform
336
337XXX
338
339=back
340
341=head1 Internal Changes
342
343XXX Changes which affect the interface available to C<XS> code go here. Other
344significant internal changes for future core maintainers should be noted as
345well.
346
347[ List each change as an =item entry ]
348
349=over 4
350
351=item *
352
fb55ce6b
TC
353L<eval_pv()|perlapi/eval_pv> no longer stringifies the exception when
354C<croak_on_error> is true. [perl #134175]
8424e368
S
355
356=back
357
358=head1 Selected Bug Fixes
359
360XXX Important bug fixes in the core language are summarized here. Bug fixes in
361files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
362
363[ List each fix as an =item entry ]
364
365=over 4
366
367=item *
368
fd0b39e2
TC
369close() on a pipe now preemptively clears the PerlIO object from the
370IO SV. This prevents a second attempt to close the already closed
371PerlIO object if a signal handler calls die() or exit() while close()
372is waiting for the child process to complete. [perl #122112]
8424e368 373
ddf10889
TC
374=item *
375
376C<< sprintf("%.*a", -10000, $x) >> would cause a buffer overflow due
377to mishandling of the negative precision value. [perl #134008]
378
755e4cab
TC
379=item *
380
381scalar() on a reference could cause an erroneous assertion failure
382during compilation. [perl #134045]
383
fef47ada
TC
384=item *
385
386Extraordinarily large (over 2GB) floating point format widths could
387cause an integer overflow in the underlying call to snprintf(),
388resulting in an assertion. Formatted floating point widths are now
389limited to the range of int, the return value of snprintf(). [perl
390#133913]
391
8424e368
S
392=back
393
394=head1 Known Problems
395
396XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
397tests that had to be C<TODO>ed for the release would be noted here. Unfixed
398platform specific bugs also go here.
399
400[ List each fix as an =item entry ]
401
402=over 4
403
404=item *
405
406XXX
407
408=back
409
410=head1 Errata From Previous Releases
411
412=over 4
413
414=item *
415
416XXX Add anything here that we forgot to add, or were mistaken about, in
417the perldelta of a previous release.
418
419=back
420
421=head1 Obituary
422
423XXX If any significant core contributor or member of the CPAN community has
424died, add a short obituary here.
425
426=head1 Acknowledgements
427
428XXX Generate this with:
429
430 perl Porting/acknowledgements.pl v5.31.0..HEAD
431
44691e6f
AB
432=head1 Reporting Bugs
433
373fec1e 434If you find what you think is a bug, you might check the perl bug database
15f62f05
KE
435at L<https://rt.perl.org/>. There may also be information at
436L<http://www.perl.org/>, the Perl Home Page.
44691e6f 437
e08634c5
SH
438If you believe you have an unreported bug, please run the L<perlbug> program
439included with your release. Be sure to trim your bug down to a tiny but
440sufficient test case. Your bug report, along with the output of C<perl -V>,
0e18d1c4 441will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f 442
87c118b9
DM
443If the bug you are reporting has security implications which make it
444inappropriate to send to a publicly archived mailing list, then see
373fec1e
SH
445L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
446for details of how to report the issue.
44691e6f 447
390ae6f9
S
448=head1 Give Thanks
449
373fec1e
SH
450If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
451you can do so by running the C<perlthanks> program:
390ae6f9
S
452
453 perlthanks
454
455This will send an email to the Perl 5 Porters list with your show of thanks.
456
44691e6f
AB
457=head1 SEE ALSO
458
e08634c5
SH
459The F<Changes> file for an explanation of how to view exhaustive details on
460what changed.
44691e6f
AB
461
462The F<INSTALL> file for how to build Perl.
463
464The F<README> file for general stuff.
465
466The F<Artistic> and F<Copying> files for copyright information.
467
468=cut