This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
New perldelta
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
3ce6a296
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.25.9
eabfc7bc 9
2cfe9b50 10=head1 DESCRIPTION
eabfc7bc 11
3ce6a296 12This document describes differences between the 5.25.8 release and the 5.25.9
4b8803f0 13release.
f3ed8cbf 14
3ce6a296
S
15If you are upgrading from an earlier release such as 5.25.7, first read
16L<perl5258delta>, which describes differences between 5.25.7 and 5.25.8.
17
18=head1 Notice
19
20XXX Any important notices here
8bbdbfcb 21
733dba2b 22=head1 Core Enhancements
ce6646d7 23
3ce6a296
S
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 inapplicable.
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.
eaed4a85 69
3ce6a296 70=over
eaed4a85 71
3ce6a296
S
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 ]
eaed4a85 80
733dba2b 81=head1 Performance Enhancements
226eba01 82
3ce6a296
S
83XXX Changes which enhance performance without changing behaviour go here.
84There may well be none in a stable release.
8bbdbfcb 85
3ce6a296 86[ List each enhancement as a =item entry ]
8bbdbfcb 87
3ce6a296 88=over 4
8bbdbfcb 89
3ce6a296 90=item *
dd3d2a3f 91
3ce6a296 92XXX
dd3d2a3f 93
8bbdbfcb
CG
94=back
95
733dba2b 96=head1 Modules and Pragmata
8bbdbfcb 97
3ce6a296
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
104[ Within each section, list entries as a =item entry ]
105
106=head2 New Modules and Pragmata
8bbdbfcb
CG
107
108=over 4
109
110=item *
111
3ce6a296 112XXX
8bbdbfcb 113
3ce6a296
S
114=back
115
116=head2 Updated Modules and Pragmata
ff10d69b 117
3ce6a296 118=over 4
ff10d69b 119
76ea8b6a
JK
120=item *
121
3ce6a296 122L<XXX> has been upgraded from version A.xx to B.yy.
8bbdbfcb 123
3ce6a296 124=back
8bbdbfcb 125
3ce6a296
S
126=head2 Removed Modules and Pragmata
127
128=over 4
8bbdbfcb
CG
129
130=item *
131
3ce6a296 132XXX
8bbdbfcb 133
3ce6a296 134=back
8bbdbfcb 135
3ce6a296 136=head1 Documentation
8bbdbfcb 137
3ce6a296
S
138XXX Changes to files in F<pod/> go here. Consider grouping entries by
139file and be sure to link to the appropriate page, e.g. L<perlfunc>.
8bbdbfcb 140
3ce6a296 141=head2 New Documentation
8bbdbfcb 142
3ce6a296 143XXX Changes which create B<new> files in F<pod/> go here.
8bbdbfcb 144
3ce6a296 145=head3 L<XXX>
8bbdbfcb 146
3ce6a296 147XXX Description of the purpose of the new file here
8bbdbfcb 148
3ce6a296 149=head2 Changes to Existing Documentation
8bbdbfcb 150
3ce6a296
S
151XXX Changes which significantly change existing files in F<pod/> go here.
152However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
153section.
154
155=head3 L<XXX>
8bbdbfcb 156
3ce6a296 157=over 4
8bbdbfcb 158
107db227 159=item *
8bbdbfcb 160
3ce6a296 161XXX Description of the change here
8bbdbfcb 162
3ce6a296 163=back
8bbdbfcb 164
3ce6a296 165=head1 Diagnostics
8bbdbfcb 166
3ce6a296
S
167The following additions or changes have been made to diagnostic output,
168including warnings and fatal error messages. For the complete list of
169diagnostic messages, see L<perldiag>.
170
171XXX New or changed warnings emitted by the core's C<C> code go here. Also
172include any changes in L<perldiag> that reconcile it to the C<C> code.
8c3f6b0b 173
3ce6a296
S
174=head2 New Diagnostics
175
176XXX Newly added diagnostic messages go under here, separated into New Errors
177and New Warnings
178
179=head3 New Errors
180
181=over 4
a09f502b 182
107db227 183=item *
2c4879e2 184
3ce6a296
S
185XXX L<message|perldiag/"message">
186
187=back
188
189=head3 New Warnings
190
191=over 4
8bbdbfcb
CG
192
193=item *
194
3ce6a296
S
195XXX L<message|perldiag/"message">
196
197=back
198
199=head2 Changes to Existing Diagnostics
200
201XXX Changes (i.e. rewording) of diagnostic messages go here
202
203=over 4
bd5630ab 204
107db227 205=item *
2c4879e2 206
3ce6a296
S
207XXX Describe change here
208
209=back
210
211=head1 Utility Changes
212
213XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
214Most of these are built within the directory F<utils>.
215
216[ List utility changes as a =head2 entry for each utility and =item
217entries for each change
218Use L<XXX> with program names to get proper documentation linking. ]
219
220=head2 L<XXX>
221
222=over 4
a09f502b 223
107db227 224=item *
8bbdbfcb 225
3ce6a296
S
226XXX
227
228=back
229
230=head1 Configuration and Compilation
231
232XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
233go here. Any other changes to the Perl build process should be listed here.
234However, any platform-specific changes should be listed in the
235L</Platform Support> section, instead.
236
237[ List changes as a =item entry ].
238
239=over 4
8bbdbfcb 240
107db227 241=item *
8bbdbfcb 242
3ce6a296
S
243XXX
244
245=back
246
247=head1 Testing
248
249XXX Any significant changes to the testing of a freshly built perl should be
250listed here. Changes which create B<new> files in F<t/> go here as do any
251large changes to the testing harness (e.g. when parallel testing was added).
252Changes to existing files in F<t/> aren't worth summarizing, although the bugs
253that they represent may be covered elsewhere.
254
255[ List each test improvement as a =item entry ]
256
257=over 4
8bbdbfcb
CG
258
259=item *
260
3ce6a296 261XXX
07cfdfcc 262
262514fd 263=back
2c4879e2 264
3ce6a296
S
265=head1 Platform Support
266
267XXX Any changes to platform support should be listed in the sections below.
268
269[ Within the sections, list each platform as a =item entry with specific
270changes as paragraphs below it. ]
271
272=head2 New Platforms
273
274XXX List any platforms that this version of perl compiles on, that previous
275versions did not. These will either be enabled by new files in the F<hints/>
276directories, or new subdirectories and F<README> files at the top level of the
277source tree.
278
279=over 4
280
281=item XXX-some-platform
282
283XXX
284
285=back
286
287=head2 Discontinued Platforms
288
289XXX List any platforms that this version of perl no longer compiles on.
290
291=over 4
292
293=item XXX-some-platform
294
295XXX
296
297=back
298
299=head2 Platform-Specific Notes
300
301XXX List any changes for specific platforms. This could include configuration
302and compilation changes or changes in portability/compatibility. However,
303changes within modules for platforms should generally be listed in the
304L</Modules and Pragmata> section.
305
306=over 4
307
308=item XXX-some-platform
309
310XXX
311
312=back
313
314=head1 Internal Changes
315
316XXX Changes which affect the interface available to C<XS> code go here. Other
317significant internal changes for future core maintainers should be noted as
318well.
319
320[ List each change as a =item entry ]
a09f502b 321
733dba2b 322=over 4
a09f502b 323
a07f6112 324=item *
a09f502b 325
3ce6a296
S
326XXX
327
328=back
329
330=head1 Selected Bug Fixes
331
332XXX Important bug fixes in the core language are summarized here. Bug fixes in
333files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
334
335[ List each fix as a =item entry ]
336
337=over 4
a09f502b 338
36cabe94
YO
339=item *
340
3ce6a296
S
341XXX
342
343=back
344
345=head1 Known Problems
346
347XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
348tests that had to be C<TODO>ed for the release would be noted here. Unfixed
349platform specific bugs also go here.
36cabe94 350
3ce6a296
S
351[ List each fix as a =item entry ]
352
353=over 4
354
355=item *
356
357XXX
36cabe94 358
a07f6112 359=back
7d897bd0 360
3ce6a296
S
361=head1 Errata From Previous Releases
362
363=over 4
8bbdbfcb 364
3ce6a296
S
365=item *
366
367XXX Add anything here that we forgot to add, or were mistaken about, in
368the perldelta of a previous release.
8bbdbfcb 369
3ce6a296 370=back
262514fd 371
3ce6a296 372=head1 Obituary
a6a32e96 373
3ce6a296
S
374XXX If any significant core contributor has died, we've added a short obituary
375here.
262514fd 376
3ce6a296 377=head1 Acknowledgements
226eba01 378
3ce6a296 379XXX Generate this with:
24528e8e 380
3ce6a296 381 perl Porting/acknowledgements.pl v5.25.5..HEAD
f5b73711 382
44691e6f
AB
383=head1 Reporting Bugs
384
c0ea3294
SH
385If you find what you think is a bug, you might check the perl bug database
386at L<https://rt.perl.org/> . There may also be information at
4b8803f0 387L<http://www.perl.org/> , the Perl Home Page.
44691e6f 388
e08634c5
SH
389If you believe you have an unreported bug, please run the L<perlbug> program
390included with your release. Be sure to trim your bug down to a tiny but
391sufficient test case. Your bug report, along with the output of C<perl -V>,
392will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f 393
87c118b9
DM
394If the bug you are reporting has security implications which make it
395inappropriate to send to a publicly archived mailing list, then see
c0ea3294
SH
396L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
397for details of how to report the issue.
44691e6f
AB
398
399=head1 SEE ALSO
400
e08634c5
SH
401The F<Changes> file for an explanation of how to view exhaustive details on
402what changed.
44691e6f
AB
403
404The F<INSTALL> file for how to build Perl.
405
406The F<README> file for general stuff.
407
408The F<Artistic> and F<Copying> files for copyright information.
409
410=cut