This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
PerlIO::Via: check arg is non-NULL before using it.
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
9064626f
SH
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.3
d407e309 9
862f380b 10=head1 DESCRIPTION
261e14b0 11
9064626f 12This document describes differences between the 5.31.2 release and the 5.31.3
862f380b 13release.
261e14b0 14
9064626f
SH
15If you are upgrading from an earlier release such as 5.31.1, first read
16L<perl5312delta>, which describes differences between 5.31.1 and 5.31.2.
8424e368 17
9064626f 18=head1 Notice
a0348300 19
9064626f
SH
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 ]
a0348300 87
9c600b76 88=over 4
a0348300 89
9c600b76 90=item *
a0348300 91
9064626f 92XXX
a0348300 93
9064626f 94=back
9c600b76 95
9064626f 96=head1 Modules and Pragmata
a0348300 97
9064626f
SH
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.
a0348300 103
9064626f
SH
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.)
a0348300 109
9064626f
SH
110[ Within each section, list entries as an =item entry ]
111
112=head2 New Modules and Pragmata
a0348300 113
9064626f 114=over 4
dad02c36 115
9c600b76
SH
116=item *
117
9064626f 118XXX Remove this section if not applicable.
a0348300 119
9064626f 120=back
a0348300 121
9064626f
SH
122=head2 Updated Modules and Pragmata
123
124=over 4
a0348300 125
9c600b76 126=item *
a0348300 127
03b7d279
TC
128L<Devel::PPPort> has been upgraded from version 3.54 to 3.55.
129
130The test files generated on Win32 are now identical to when they are
131generated on POSIX-like systems.
132
133=item *
134
135L<File::Find> has been upgraded from version 1.36 to 1.37.
136
137On Win32, the tests no longer require either a file in the drive root
138directory, or a writable root directory.
139
140=item *
141
36bb8f68
JK
142L<Thread> has been upgraded from version 3.04 to 3.05.
143
144=item *
145
9064626f
SH
146L<XXX> has been upgraded from version A.xx to B.yy.
147
148If there was something important to note about this change, include that here.
149
150=back
151
152=head2 Removed Modules and Pragmata
153
154=over 4
dad02c36 155
9c600b76 156=item *
dad02c36 157
9064626f
SH
158XXX
159
160=back
161
162=head1 Documentation
163
164XXX Changes to files in F<pod/> go here. Consider grouping entries by
165file and be sure to link to the appropriate page, e.g. L<perlfunc>.
166
167=head2 New Documentation
168
169XXX Changes which create B<new> files in F<pod/> go here.
170
171=head3 L<XXX>
172
173XXX Description of the purpose of the new file here
174
175=head2 Changes to Existing Documentation
176
177We have attempted to update the documentation to reflect the changes
178listed in this document. If you find any we have missed, send email
179to L<perlbug@perl.org|mailto:perlbug@perl.org>.
180
181XXX Changes which significantly change existing files in F<pod/> go here.
182However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
183section.
184
185Additionally, the following selected changes have been made:
186
187=head3 L<XXX>
188
189=over 4
cc1cbb06
TC
190
191=item *
192
9064626f 193XXX Description of the change here
8424e368 194
dad02c36 195=back
a0348300 196
dad02c36 197=head1 Diagnostics
a0348300 198
9064626f
SH
199The following additions or changes have been made to diagnostic output,
200including warnings and fatal error messages. For the complete list of
201diagnostic messages, see L<perldiag>.
202
203XXX New or changed warnings emitted by the core's C<C> code go here. Also
204include any changes in L<perldiag> that reconcile it to the C<C> code.
205
dad02c36 206=head2 New Diagnostics
8424e368 207
9064626f
SH
208XXX Newly added diagnostic messages go under here, separated into New Errors
209and New Warnings
210
dad02c36 211=head3 New Errors
8424e368
S
212
213=over 4
214
215=item *
216
9064626f 217XXX L<message|perldiag/"message">
8424e368 218
9064626f
SH
219=back
220
221=head3 New Warnings
222
223=over 4
224
225=item *
226
227XXX L<message|perldiag/"message">
8424e368 228
dad02c36
KE
229=back
230
231=head2 Changes to Existing Diagnostics
232
9064626f
SH
233XXX Changes (i.e. rewording) of diagnostic messages go here
234
860a458f
KE
235=over 4
236
237=item *
238
9064626f
SH
239XXX Describe change here
240
241=back
242
243=head1 Utility Changes
244
245XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
246Most of these are built within the directory F<utils>.
247
248[ List utility changes as a =head2 entry for each utility and =item
249entries for each change
250Use L<XXX> with program names to get proper documentation linking. ]
251
252=head2 L<XXX>
253
254=over 4
255
256=item *
1a7108fe 257
9064626f 258XXX
860a458f
KE
259
260=back
261
8424e368
S
262=head1 Configuration and Compilation
263
9064626f
SH
264XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
265go here. Any other changes to the Perl build process should be listed here.
266However, any platform-specific changes should be listed in the
267L</Platform Support> section, instead.
268
269[ List changes as an =item entry ].
270
8424e368
S
271=over 4
272
273=item *
274
9064626f
SH
275XXX
276
277=back
278
279=head1 Testing
280
281XXX Any significant changes to the testing of a freshly built perl should be
282listed here. Changes which create B<new> files in F<t/> go here as do any
283large changes to the testing harness (e.g. when parallel testing was added).
284Changes to existing files in F<t/> aren't worth summarizing, although the bugs
285that they represent may be covered elsewhere.
286
287XXX If there were no significant test changes, say this:
288
289Tests were added and changed to reflect the other additions and changes
290in this release.
291
292XXX If instead there were significant changes, say this:
293
294Tests were added and changed to reflect the other additions and
295changes in this release. Furthermore, these significant changes were
296made:
297
298[ List each test improvement as an =item entry ]
299
300=over 4
8424e368 301
86b50d93
DIM
302=item *
303
9064626f 304XXX
86b50d93 305
8424e368
S
306=back
307
dad02c36 308=head1 Platform Support
8424e368 309
9064626f 310XXX Any changes to platform support should be listed in the sections below.
fef47ada 311
9064626f
SH
312[ Within the sections, list each platform as an =item entry with specific
313changes as paragraphs below it. ]
4ec3954c 314
9064626f 315=head2 New Platforms
ec121dac 316
9064626f
SH
317XXX List any platforms that this version of perl compiles on, that previous
318versions did not. These will either be enabled by new files in the F<hints/>
319directories, or new subdirectories and F<README> files at the top level of the
320source tree.
ec121dac 321
9064626f 322=over 4
4ec3954c 323
9064626f
SH
324=item XXX-some-platform
325
326XXX
4ec3954c 327
dad02c36 328=back
4ec3954c 329
9064626f 330=head2 Discontinued Platforms
4ec3954c 331
9064626f 332XXX List any platforms that this version of perl no longer compiles on.
4ec3954c 333
9064626f 334=over 4
4ec3954c 335
9064626f 336=item XXX-some-platform
4ec3954c 337
9064626f 338XXX
b870557c 339
9064626f 340=back
b870557c 341
9064626f 342=head2 Platform-Specific Notes
ed0cf058 343
9064626f
SH
344XXX List any changes for specific platforms. This could include configuration
345and compilation changes or changes in portability/compatibility. However,
346changes within modules for platforms should generally be listed in the
347L</Modules and Pragmata> section.
ed0cf058 348
9064626f 349=over 4
f7faf2ad 350
efb1f9ac 351=item Windows
f7faf2ad 352
efb1f9ac
TC
353F<t/op/magic.t> could fail if environment varables starting with
354C<FOO> already existed.
f7faf2ad 355
4ec3954c
TC
356=back
357
9064626f 358=head1 Internal Changes
4ec3954c 359
9064626f
SH
360XXX Changes which affect the interface available to C<XS> code go here. Other
361significant internal changes for future core maintainers should be noted as
362well.
2dd5ef16 363
9064626f 364[ List each change as an =item entry ]
5b2f1ba6 365
9064626f 366=over 4
5b2f1ba6 367
b870557c
TC
368=item *
369
996b0cb8
PE
370A new parser function L<parse_subsignature()|perlapi/parse_subsignature>
371allows a keyword plugin to parse a subroutine signature while C<use feature
372'signatures'> is in effect. This allows custom keywords to implement
373semantics similar to regular C<sub> declarations that include signatures.
374[perl #132474]
b870557c 375
061637ca
HS
376=item *
377
378Since on some platforms we need to hold a mutex when temporarily
379switching locales, new macros (C<STORE_LC_NUMERIC_SET_TO_NEEDED_IN>,
380C<WITH_LC_NUMERIC_SET_TO_NEEDED> and C<WITH_LC_NUMERIC_SET_TO_NEEDED_IN>)
381have been added to make it easier to do this safely and efficiently
382as part of [perl #134172].
383
9064626f 384=back
ed0cf058 385
9064626f 386=head1 Selected Bug Fixes
ed0cf058 387
9064626f
SH
388XXX Important bug fixes in the core language are summarized here. Bug fixes in
389files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
973ae088 390
9064626f
SH
391[ List each fix as an =item entry ]
392
393=over 4
973ae088 394
f7faf2ad
SH
395=item *
396
052ce2b8
TC
397C<< $@ = 100; die; >> now correctly propagates the 100 as an exception
398instead of ignoring it. [perl #134291]
f7faf2ad 399
a3c77565
TC
400=item *
401
402C<< 0 0x@ >> no longer asserts in S_no_op(). [perl #134310]
403
dad02c36 404=back
5b2f1ba6 405
dad02c36 406=head1 Known Problems
5b2f1ba6 407
9064626f
SH
408XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
409tests that had to be C<TODO>ed for the release would be noted here. Unfixed
410platform specific bugs also go here.
84ab3b69 411
9064626f 412[ List each fix as an =item entry ]
fa068f6d 413
9064626f 414=over 4
cb561db1
SH
415
416=item *
417
9064626f 418XXX
fa068f6d 419
8424e368
S
420=back
421
9064626f
SH
422=head1 Errata From Previous Releases
423
424=over 4
a0348300 425
9064626f
SH
426=item *
427
428XXX Add anything here that we forgot to add, or were mistaken about, in
429the perldelta of a previous release.
8424e368 430
9064626f 431=back
a01eaaa1 432
9064626f 433=head1 Obituary
a01eaaa1 434
9064626f
SH
435XXX If any significant core contributor or member of the CPAN community has
436died, add a short obituary here.
a01eaaa1 437
9064626f 438=head1 Acknowledgements
a01eaaa1 439
9064626f 440XXX Generate this with:
a01eaaa1 441
9064626f 442 perl Porting/acknowledgements.pl v5.31.2..HEAD
8424e368 443
44691e6f
AB
444=head1 Reporting Bugs
445
9064626f
SH
446If you find what you think is a bug, you might check the perl bug database
447at L<https://rt.perl.org/>. There may also be information at
15f62f05 448L<http://www.perl.org/>, the Perl Home Page.
44691e6f 449
e08634c5
SH
450If you believe you have an unreported bug, please run the L<perlbug> program
451included with your release. Be sure to trim your bug down to a tiny but
452sufficient test case. Your bug report, along with the output of C<perl -V>,
0e18d1c4 453will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f 454
87c118b9
DM
455If the bug you are reporting has security implications which make it
456inappropriate to send to a publicly archived mailing list, then see
9064626f
SH
457L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
458for details of how to report the issue.
44691e6f 459
390ae6f9
S
460=head1 Give Thanks
461
9064626f
SH
462If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
463you can do so by running the C<perlthanks> program:
390ae6f9
S
464
465 perlthanks
466
467This will send an email to the Perl 5 Porters list with your show of thanks.
468
44691e6f
AB
469=head1 SEE ALSO
470
e08634c5
SH
471The F<Changes> file for an explanation of how to view exhaustive details on
472what changed.
44691e6f
AB
473
474The F<INSTALL> file for how to build Perl.
475
476The F<README> file for general stuff.
477
478The F<Artistic> and F<Copying> files for copyright information.
479
480=cut