This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta: Fix typo
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
fcbec156
TH
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.4
d407e309 9
862f380b 10=head1 DESCRIPTION
261e14b0 11
fcbec156 12This document describes differences between the 5.31.3 release and the 5.31.4
862f380b 13release.
261e14b0 14
fcbec156
TH
15If you are upgrading from an earlier release such as 5.31.2, first read
16L<perl5313delta>, which describes differences between 5.31.2 and 5.31.3.
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
f0556e94 30=head2 Now can dump compiled patterns before optimization
fd41b2d1
KW
31
32This is primarily useful for tracking down bugs in the regular
33expression compiler. This dump happens on C<-DDEBUGGING> perls, if you
34specify C<-Drv> on the command line; or on any perl if the pattern is
35compiled within the scope of S<C<use re qw(Debug DUMP_PRE_OPTIMIZE)>> or
36S<C<use re qw(Debug COMPILE EXTRA)>>. (All but the 2nd case display
37other information as well.)
38
fcbec156
TH
39=head1 Security
40
41XXX Any security-related notices go here. In particular, any security
42vulnerabilities closed should be noted here rather than in the
43L</Selected Bug Fixes> section.
44
45[ List each security issue as a =head2 entry ]
8424e368 46
9064626f
SH
47=head1 Incompatible Changes
48
fcbec156 49XXX For a release on a stable branch, this section aspires to be:
e6132dc0 50
fcbec156
TH
51 There are no changes intentionally incompatible with 5.XXX.XXX
52 If any exist, they are bugs, and we request that you submit a
53 report. See L</Reporting Bugs> below.
e6132dc0 54
fcbec156 55[ List each incompatible change as a =head2 entry ]
e6132dc0 56
fcbec156 57=head1 Deprecations
e6132dc0 58
fcbec156 59XXX Any deprecated features, syntax, modules etc. should be listed here.
befef368 60
fcbec156 61=head2 Module removals
befef368 62
fcbec156 63XXX Remove this section if not applicable.
befef368 64
fcbec156
TH
65The following modules will be removed from the core distribution in a
66future release, and will at that time need to be installed from CPAN.
67Distributions on CPAN which require these modules will need to list them as
68prerequisites.
a0348300 69
fcbec156
TH
70The core versions of these modules will now issue C<"deprecated">-category
71warnings to alert you to this fact. To silence these deprecation warnings,
72install the modules in question from CPAN.
73
74Note that these are (with rare exceptions) fine modules that you are encouraged
75to continue to use. Their disinclusion from core primarily hinges on their
76necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
77not usually on concerns over their design.
78
79=over
80
81=item XXX
82
83XXX Note that deprecated modules should be listed here even if they are listed
84as an updated module in the L</Modules and Pragmata> section.
85
86=back
87
88[ List each other deprecation as a =head2 entry ]
89
90=head1 Performance Enhancements
91
92XXX Changes which enhance performance without changing behaviour go here.
93There may well be none in a stable release.
94
95[ List each enhancement as an =item entry ]
9064626f
SH
96
97=over 4
a0348300 98
9c600b76 99=item *
a0348300 100
fcbec156 101XXX
be2eb09e 102
fcbec156
TH
103=back
104
105=head1 Modules and Pragmata
be2eb09e 106
fcbec156
TH
107XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
108go here. If Module::CoreList is updated, generate an initial draft of the
109following sections using F<Porting/corelist-perldelta.pl>. A paragraph summary
110for important changes should then be added by hand. In an ideal world,
111dual-life modules would have a F<Changes> file that could be cribbed.
be2eb09e 112
fcbec156
TH
113The list of new and updated modules is modified automatically as part of
114preparing a Perl release, so the only reason to manually add entries here is if
115you're summarising the important changes in the module update. (Also, if the
116manually-added details don't match the automatically-generated ones, the
117release manager will have to investigate the situation carefully.)
be2eb09e 118
fcbec156 119[ Within each section, list entries as an =item entry ]
03b7d279 120
fcbec156
TH
121=head2 New Modules and Pragmata
122
123=over 4
03b7d279
TC
124
125=item *
126
fcbec156 127XXX Remove this section if not applicable.
03b7d279 128
fcbec156 129=back
03b7d279 130
fcbec156 131=head2 Updated Modules and Pragmata
03b7d279 132
fcbec156 133=over 4
36bb8f68
JK
134
135=item *
136
fcbec156 137L<XXX> has been upgraded from version A.xx to B.yy.
be2eb09e 138
fcbec156 139If there was something important to note about this change, include that here.
be2eb09e 140
fcbec156 141=back
be2eb09e 142
fcbec156
TH
143=head2 Removed Modules and Pragmata
144
145=over 4
be2eb09e
TH
146
147=item *
148
fcbec156
TH
149XXX
150
151=back
152
153=head1 Documentation
154
155XXX Changes to files in F<pod/> go here. Consider grouping entries by
156file and be sure to link to the appropriate page, e.g. L<perlfunc>.
157
158=head2 New Documentation
159
160XXX Changes which create B<new> files in F<pod/> go here.
161
162=head3 L<XXX>
163
164XXX Description of the purpose of the new file here
165
166=head2 Changes to Existing Documentation
167
168We have attempted to update the documentation to reflect the changes
169listed in this document. If you find any we have missed, send email
170to L<perlbug@perl.org|mailto:perlbug@perl.org>.
171
172XXX Changes which significantly change existing files in F<pod/> go here.
173However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
174section.
175
176Additionally, the following selected changes have been made:
177
178=head3 L<XXX>
179
180=over 4
be2eb09e
TH
181
182=item *
183
fcbec156
TH
184XXX Description of the change here
185
186=back
187
188=head1 Diagnostics
189
190The following additions or changes have been made to diagnostic output,
191including warnings and fatal error messages. For the complete list of
192diagnostic messages, see L<perldiag>.
193
194XXX New or changed warnings emitted by the core's C<C> code go here. Also
195include any changes in L<perldiag> that reconcile it to the C<C> code.
196
197=head2 New Diagnostics
198
199XXX Newly added diagnostic messages go under here, separated into New Errors
200and New Warnings
201
202=head3 New Errors
203
204=over 4
be2eb09e
TH
205
206=item *
207
fcbec156
TH
208XXX L<message|perldiag/"message">
209
210=back
211
212=head3 New Warnings
213
214=over 4
be2eb09e
TH
215
216=item *
217
fcbec156
TH
218XXX L<message|perldiag/"message">
219
220=back
221
222=head2 Changes to Existing Diagnostics
223
224XXX Changes (i.e. rewording) of diagnostic messages go here
225
226=over 4
be2eb09e
TH
227
228=item *
229
fcbec156
TH
230XXX Describe change here
231
232=back
233
234=head1 Utility Changes
235
236XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
237Most of these are built within the directory F<utils>.
238
239[ List utility changes as a =head2 entry for each utility and =item
240entries for each change
241Use L<XXX> with program names to get proper documentation linking. ]
242
243=head2 L<XXX>
244
245=over 4
8639f158
JK
246
247=item *
248
fcbec156
TH
249XXX
250
251=back
252
253=head1 Configuration and Compilation
254
255XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
256go here. Any other changes to the Perl build process should be listed here.
257However, any platform-specific changes should be listed in the
258L</Platform Support> section, instead.
259
260[ List changes as an =item entry ].
f0f66070 261
fcbec156 262=over 4
f0f66070
TC
263
264=item *
265
fcbec156
TH
266XXX
267
268=back
269
270=head1 Testing
271
272XXX Any significant changes to the testing of a freshly built perl should be
273listed here. Changes which create B<new> files in F<t/> go here as do any
274large changes to the testing harness (e.g. when parallel testing was added).
275Changes to existing files in F<t/> aren't worth summarizing, although the bugs
276that they represent may be covered elsewhere.
277
278XXX If there were no significant test changes, say this:
279
280Tests were added and changed to reflect the other additions and changes
281in this release.
282
283XXX If instead there were significant changes, say this:
284
285Tests were added and changed to reflect the other additions and
286changes in this release. Furthermore, these significant changes were
287made:
288
289[ List each test improvement as an =item entry ]
290
291=over 4
a4635286
KW
292
293=item *
294
fcbec156 295XXX
589e04a1 296
8424e368
S
297=back
298
dad02c36 299=head1 Platform Support
8424e368 300
fcbec156
TH
301XXX Any changes to platform support should be listed in the sections below.
302
303[ Within the sections, list each platform as an =item entry with specific
304changes as paragraphs below it. ]
305
306=head2 New Platforms
307
308XXX List any platforms that this version of perl compiles on, that previous
309versions did not. These will either be enabled by new files in the F<hints/>
310directories, or new subdirectories and F<README> files at the top level of the
311source tree.
ed0cf058 312
9064626f 313=over 4
f7faf2ad 314
fcbec156 315=item XXX-some-platform
f7faf2ad 316
fcbec156 317XXX
f7faf2ad 318
4ec3954c
TC
319=back
320
fcbec156
TH
321=head2 Discontinued Platforms
322
323XXX List any platforms that this version of perl no longer compiles on.
4ec3954c 324
9064626f 325=over 4
5b2f1ba6 326
fcbec156 327=item XXX-some-platform
b870557c 328
fcbec156 329XXX
b870557c 330
fcbec156
TH
331=back
332
333=head2 Platform-Specific Notes
334
335XXX List any changes for specific platforms. This could include configuration
336and compilation changes or changes in portability/compatibility. However,
337changes within modules for platforms should generally be listed in the
338L</Modules and Pragmata> section.
339
340=over 4
061637ca 341
fcbec156
TH
342=item XXX-some-platform
343
344XXX
345
346=back
347
348=head1 Internal Changes
349
350XXX Changes which affect the interface available to C<XS> code go here. Other
351significant internal changes for future core maintainers should be noted as
352well.
353
354[ List each change as an =item entry ]
355
356=over 4
061637ca 357
285db695
DM
358=item *
359
fcbec156 360XXX
285db695 361
9064626f 362=back
ed0cf058 363
9064626f 364=head1 Selected Bug Fixes
ed0cf058 365
fcbec156
TH
366XXX Important bug fixes in the core language are summarized here. Bug fixes in
367files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
368
369[ List each fix as an =item entry ]
370
9064626f 371=over 4
973ae088 372
f7faf2ad
SH
373=item *
374
9cb69123
TC
375Perl no longer treats strings starting with "0x" or "0b" as hex or
376binary numbers respectively when converting a string to a number.
377This reverts a change in behaviour inadvertently introduced in perl
3785.30.0 intended to improve precision when converting a string to a
379floating point number. [perl #134230]
f7faf2ad 380
fcbec156
TH
381=back
382
383=head1 Known Problems
384
385XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
386tests that had to be C<TODO>ed for the release would be noted here. Unfixed
387platform specific bugs also go here.
388
389[ List each fix as an =item entry ]
a3c77565 390
fcbec156 391=over 4
a3c77565 392
6e23836a
TC
393=item *
394
fcbec156 395XXX
6e23836a 396
dad02c36 397=back
5b2f1ba6 398
fcbec156
TH
399=head1 Errata From Previous Releases
400
401=over 4
a01eaaa1 402
fcbec156
TH
403=item *
404
405XXX Add anything here that we forgot to add, or were mistaken about, in
406the perldelta of a previous release.
bd833cba 407
fcbec156 408=back
bd833cba 409
fcbec156 410=head1 Obituary
bd833cba 411
fcbec156
TH
412XXX If any significant core contributor or member of the CPAN community has
413died, add a short obituary here.
bd833cba 414
fcbec156 415=head1 Acknowledgements
bd833cba 416
fcbec156 417XXX Generate this with:
bd833cba 418
fcbec156 419 perl Porting/acknowledgements.pl v5.31.3..HEAD
8424e368 420
44691e6f
AB
421=head1 Reporting Bugs
422
9064626f
SH
423If you find what you think is a bug, you might check the perl bug database
424at L<https://rt.perl.org/>. There may also be information at
15f62f05 425L<http://www.perl.org/>, the Perl Home Page.
44691e6f 426
e08634c5
SH
427If you believe you have an unreported bug, please run the L<perlbug> program
428included with your release. Be sure to trim your bug down to a tiny but
429sufficient test case. Your bug report, along with the output of C<perl -V>,
0e18d1c4 430will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f 431
87c118b9
DM
432If the bug you are reporting has security implications which make it
433inappropriate to send to a publicly archived mailing list, then see
9064626f
SH
434L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
435for details of how to report the issue.
44691e6f 436
390ae6f9
S
437=head1 Give Thanks
438
9064626f
SH
439If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
440you can do so by running the C<perlthanks> program:
390ae6f9
S
441
442 perlthanks
443
444This will send an email to the Perl 5 Porters list with your show of thanks.
445
44691e6f
AB
446=head1 SEE ALSO
447
e08634c5
SH
448The F<Changes> file for an explanation of how to view exhaustive details on
449what changed.
44691e6f
AB
450
451The F<INSTALL> file for how to build Perl.
452
453The F<README> file for general stuff.
454
455The F<Artistic> and F<Copying> files for copyright information.
456
457=cut