This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for b79cd7dfef
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
7a54f67e
CBW
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.29.3
e4c43fa1 9
4026b091
S
10=head1 DESCRIPTION
11
7a54f67e 12This document describes differences between the 5.29.2 release and the 5.29.3
4026b091
S
13release.
14
7a54f67e
CBW
15If you are upgrading from an earlier release such as 5.29.1, first read
16L<perl5292delta>, which describes differences between 5.29.1 and 5.29.2.
17
18=head1 Notice
19
20XXX Any important notices here
373fec1e 21
373fec1e
SH
22=head1 Core Enhancements
23
7a54f67e
CBW
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.
8a6698d7 27
7a54f67e 28[ List each enhancement as a =head2 entry ]
8a6698d7 29
7a54f67e 30=head1 Security
8a6698d7 31
7a54f67e
CBW
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.
8a6698d7 35
7a54f67e 36[ List each security issue as a =head2 entry ]
8a6698d7 37
7a54f67e 38=head1 Incompatible Changes
1060c83c 39
7a54f67e
CBW
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 ]
373fec1e
SH
87
88=over 4
1060c83c 89
569dc109 90=item *
1060c83c 91
7a54f67e 92XXX
8d8d86ac 93
7a54f67e
CBW
94=back
95
96=head1 Modules and Pragmata
97
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.)
8d8d86ac 109
7a54f67e
CBW
110[ Within each section, list entries as an =item entry ]
111
112=head2 New Modules and Pragmata
113
114=over 4
1060c83c 115
569dc109 116=item *
1060c83c 117
7a54f67e
CBW
118XXX Remove this section if not applicable.
119
120=back
121
122=head2 Updated Modules and Pragmata
123
124=over 4
1060c83c
S
125
126=item *
127
7a54f67e
CBW
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
1060c83c 137
569dc109 138=item *
1060c83c 139
1e28f099
KW
140C<Locale::Codes> has been removed at the request of its author. It
141continues to be available on CPAN C<L<Locale::Codes>>. [perl #133458].
7a54f67e
CBW
142
143=back
144
145=head1 Documentation
146
147XXX Changes to files in F<pod/> go here. Consider grouping entries by
148file and be sure to link to the appropriate page, e.g. L<perlfunc>.
149
150=head2 New Documentation
151
152XXX Changes which create B<new> files in F<pod/> go here.
153
154=head3 L<XXX>
155
156XXX Description of the purpose of the new file here
157
158=head2 Changes to Existing Documentation
159
160We have attempted to update the documentation to reflect the changes
161listed in this document. If you find any we have missed, send email
162to L<perlbug@perl.org|mailto:perlbug@perl.org>.
163
164XXX Changes which significantly change existing files in F<pod/> go here.
165However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
166section.
167
168Additionally, the following selected changes have been made:
169
170=head3 L<XXX>
171
172=over 4
0bb5a0fe
SH
173
174=item *
175
7a54f67e
CBW
176XXX Description of the change here
177
178=back
179
180=head1 Diagnostics
181
182The following additions or changes have been made to diagnostic output,
183including warnings and fatal error messages. For the complete list of
184diagnostic messages, see L<perldiag>.
185
186XXX New or changed warnings emitted by the core's C<C> code go here. Also
187include any changes in L<perldiag> that reconcile it to the C<C> code.
188
189=head2 New Diagnostics
190
191XXX Newly added diagnostic messages go under here, separated into New Errors
192and New Warnings
193
194=head3 New Errors
195
196=over 4
1060c83c 197
569dc109 198=item *
1060c83c 199
7a54f67e
CBW
200XXX L<message|perldiag/"message">
201
202=back
203
204=head3 New Warnings
205
206=over 4
b0a362a2
SH
207
208=item *
209
7a54f67e
CBW
210XXX L<message|perldiag/"message">
211
212=back
213
214=head2 Changes to Existing Diagnostics
215
216XXX Changes (i.e. rewording) of diagnostic messages go here
217
218=over 4
1060c83c
S
219
220=item *
221
7a54f67e
CBW
222XXX Describe change here
223
224=back
225
226=head1 Utility Changes
227
228XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
229Most of these are built within the directory F<utils>.
230
231[ List utility changes as a =head2 entry for each utility and =item
232entries for each change
233Use L<XXX> with program names to get proper documentation linking. ]
234
235=head2 L<XXX>
236
237=over 4
1060c83c
S
238
239=item *
240
7a54f67e
CBW
241XXX
242
243=back
244
245=head1 Configuration and Compilation
246
247XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
248go here. Any other changes to the Perl build process should be listed here.
249However, any platform-specific changes should be listed in the
250L</Platform Support> section, instead.
251
252[ List changes as an =item entry ].
253
254=over 4
373fec1e 255
38675b9d 256=item *
373fec1e 257
7a54f67e
CBW
258XXX
259
260=back
261
262=head1 Testing
263
264XXX Any significant changes to the testing of a freshly built perl should be
265listed here. Changes which create B<new> files in F<t/> go here as do any
266large changes to the testing harness (e.g. when parallel testing was added).
267Changes to existing files in F<t/> aren't worth summarizing, although the bugs
268that they represent may be covered elsewhere.
269
270XXX If there were no significant test changes, say this:
271
272Tests were added and changed to reflect the other additions and changes
273in this release.
274
275XXX If instead there were significant changes, say this:
276
277Tests were added and changed to reflect the other additions and
278changes in this release. Furthermore, these significant changes were
279made:
280
281[ List each test improvement as an =item entry ]
282
283=over 4
b0a362a2 284
38675b9d 285=item *
b0a362a2 286
7a54f67e
CBW
287XXX
288
289=back
290
291=head1 Platform Support
292
293XXX Any changes to platform support should be listed in the sections below.
294
295[ Within the sections, list each platform as an =item entry with specific
296changes as paragraphs below it. ]
297
298=head2 New Platforms
299
300XXX List any platforms that this version of perl compiles on, that previous
301versions did not. These will either be enabled by new files in the F<hints/>
302directories, or new subdirectories and F<README> files at the top level of the
303source tree.
304
305=over 4
306
307=item XXX-some-platform
308
309XXX
310
311=back
312
313=head2 Discontinued Platforms
314
315XXX List any platforms that this version of perl no longer compiles on.
316
317=over 4
318
319=item XXX-some-platform
320
321XXX
b0a362a2 322
373fec1e
SH
323=back
324
325=head2 Platform-Specific Notes
b0a362a2 326
7a54f67e
CBW
327XXX List any changes for specific platforms. This could include configuration
328and compilation changes or changes in portability/compatibility. However,
329changes within modules for platforms should generally be listed in the
330L</Modules and Pragmata> section.
331
373fec1e
SH
332=over 4
333
4b0bd159 334=item Windows
373fec1e 335
4b0bd159
SH
336The Windows Server 2003 SP1 Platform SDK build, with its early x64 compiler and
337tools, was accidentally broken in Perl 5.27.9. This has now been fixed.
7a54f67e
CBW
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
50749d5e
TC
350
351=item *
352
7a54f67e 353XXX
50749d5e
TC
354
355=back
b0a362a2 356
7a54f67e
CBW
357=head1 Selected Bug Fixes
358
359XXX Important bug fixes in the core language are summarized here. Bug fixes in
360files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
361
362[ List each fix as an =item entry ]
363
364=over 4
365
366=item *
367
368XXX
369
b0a362a2 370=back
1060c83c 371
7a54f67e
CBW
372=head1 Known Problems
373
374XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
375tests that had to be C<TODO>ed for the release would be noted here. Unfixed
376platform specific bugs also go here.
377
378[ List each fix as an =item entry ]
1060c83c 379
1060c83c
S
380=over 4
381
382=item *
383
7a54f67e 384XXX
373fec1e
SH
385
386=back
387
7a54f67e 388=head1 Errata From Previous Releases
c4070876 389
7a54f67e 390=over 4
c4070876 391
7a54f67e 392=item *
c4070876 393
7a54f67e
CBW
394XXX Add anything here that we forgot to add, or were mistaken about, in
395the perldelta of a previous release.
373fec1e 396
7a54f67e
CBW
397=back
398
399=head1 Obituary
373fec1e 400
7a54f67e
CBW
401XXX If any significant core contributor or member of the CPAN community has
402died, add a short obituary here.
403
404=head1 Acknowledgements
c4070876 405
7a54f67e 406XXX Generate this with:
c4070876 407
7a54f67e 408 perl Porting/acknowledgements.pl v5.29.2..HEAD
f5b73711 409
44691e6f
AB
410=head1 Reporting Bugs
411
373fec1e
SH
412If you find what you think is a bug, you might check the perl bug database
413at L<https://rt.perl.org/> . There may also be information at
b5cbfe35 414L<http://www.perl.org/> , the Perl Home Page.
44691e6f 415
e08634c5
SH
416If you believe you have an unreported bug, please run the L<perlbug> program
417included with your release. Be sure to trim your bug down to a tiny but
418sufficient test case. Your bug report, along with the output of C<perl -V>,
b5cbfe35 419will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f 420
87c118b9
DM
421If the bug you are reporting has security implications which make it
422inappropriate to send to a publicly archived mailing list, then see
373fec1e
SH
423L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
424for details of how to report the issue.
44691e6f 425
390ae6f9
S
426=head1 Give Thanks
427
373fec1e
SH
428If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
429you can do so by running the C<perlthanks> program:
390ae6f9
S
430
431 perlthanks
432
433This will send an email to the Perl 5 Porters list with your show of thanks.
434
44691e6f
AB
435=head1 SEE ALSO
436
e08634c5
SH
437The F<Changes> file for an explanation of how to view exhaustive details on
438what changed.
44691e6f
AB
439
440The F<INSTALL> file for how to build Perl.
441
442The F<README> file for general stuff.
443
444The F<Artistic> and F<Copying> files for copyright information.
445
446=cut