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