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