5 [ this is a template for a new perldelta file. Any text flagged as
6 XXX needs to be processed before release. ]
8 perldelta - what is new for perl v5.tXXX.cXXX
12 This document describes differences between the 5.sXXX.bXXX release and
13 the 5.tXXX.cXXX release.
15 If you are upgrading from an earlier release such as 5.rXXX.aXXX, first read
16 L<perl5XXXdelta>, which describes differences between 5.rXXX.aXXX and
21 XXX Any important notices here
23 =head1 Core Enhancements
25 XXX New core language features go here. Summarise user-visible core language
26 enhancements. Particularly prominent performance optimisations could go
27 here, but most should go in the L</Performance Enhancements> section.
29 [ List each enhancement as a =head2 entry ]
33 XXX Any security-related notices go here. In particular, any security
34 vulnerabilities closed should be noted here rather than in the
35 L</Selected Bug Fixes> section.
37 [ List each security issue as a =head2 entry ]
39 =head1 Incompatible Changes
41 XXX For a release on a stable branch, this section aspires to be:
43 There are no changes intentionally incompatible with 5.XXX.XXX
44 If any exist, they are bugs, and we request that you submit a
45 report. See L</Reporting Bugs> below.
47 [ List each incompatible change as a =head2 entry ]
51 XXX Any deprecated features, syntax, modules etc. should be listed here.
52 In particular, deprecated modules should be listed here even if they are
53 listed as an updated module in the L</Modules and Pragmata> section.
55 [ List each deprecation as a =head2 entry ]
57 =head1 Performance Enhancements
59 XXX Changes which enhance performance without changing behaviour go here. There
60 may well be none in a stable release.
62 [ List each enhancement as a =item entry ]
72 =head1 Modules and Pragmata
74 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
75 go here. If Module::CoreList is updated, generate an initial draft of the
76 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
77 entries to STDOUT. Results can be pasted in place of the '=head2' entries
78 below. A paragraph summary for important changes should then be added by hand.
79 In an ideal world, dual-life modules would have a F<Changes> file that could be
82 [ Within each section, list entries as a =item entry ]
84 =head2 New Modules and Pragmata
94 =head2 Updated Modules and Pragmata
100 L<XXX> has been upgraded from version 0.69 to version 0.70.
104 =head2 Removed Modules and Pragmata
116 XXX Changes to files in F<pod/> go here. Consider grouping entries by
117 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
119 =head2 New Documentation
121 XXX Changes which create B<new> files in F<pod/> go here.
125 XXX Description of the purpose of the new file here
127 =head2 Changes to Existing Documentation
129 XXX Changes which significantly change existing files in F<pod/> go here.
130 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
139 XXX Description of the change here
145 The following additions or changes have been made to diagnostic output,
146 including warnings and fatal error messages. For the complete list of
147 diagnostic messages, see L<perldiag>.
149 XXX New or changed warnings emitted by the core's C<C> code go here. Also
150 include any changes in L<perldiag> that reconcile it to the C<C> code.
152 [ Within each section, list entries as a =item entry that links to perldiag,
157 L<Invalid version object|perldiag/"Invalid version object">
160 =head2 New Diagnostics
162 XXX Newly added diagnostic messages go here
170 XXX L<message|perldiag/"message">
180 XXX L<message|perldiag/"message">
184 =head2 Changes to Existing Diagnostics
186 XXX Changes (i.e. rewording) of diagnostic messages go here
192 XXX Describe change here
196 =head1 Utility Changes
198 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
199 here. Most of these are built within the directories F<utils> and F<x2p>.
201 [ List utility changes as a =head3 entry for each utility and =item
202 entries for each change
203 Use L<XXX> with program names to get proper documentation linking. ]
215 =head1 Configuration and Compilation
217 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
218 go here. Any other changes to the Perl build process should be listed here.
219 However, any platform-specific changes should be listed in the
220 L</Platform Support> section, instead.
222 [ List changes as a =item entry ].
234 XXX Any significant changes to the testing of a freshly built perl should be
235 listed here. Changes which create B<new> files in F<t/> go here as do any
236 large changes to the testing harness (e.g. when parallel testing was added).
237 Changes to existing files in F<t/> aren't worth summarising, although the bugs
238 that they represent may be covered elsewhere.
240 [ List each test improvement as a =item entry ]
250 =head1 Platform Support
252 XXX Any changes to platform support should be listed in the sections below.
254 [ Within the sections, list each platform as a =item entry with specific
255 changes as paragraphs below it. ]
259 XXX List any platforms that this version of perl compiles on, that previous
260 versions did not. These will either be enabled by new files in the F<hints/>
261 directories, or new subdirectories and F<README> files at the top level of the
266 =item XXX-some-platform
272 =head2 Discontinued Platforms
274 XXX List any platforms that this version of perl no longer compiles on.
278 =item XXX-some-platform
284 =head2 Platform-Specific Notes
286 XXX List any changes for specific platforms. This could include configuration
287 and compilation changes or changes in portability/compatibility. However,
288 changes within modules for platforms should generally be listed in the
289 L</Modules and Pragmata> section.
293 =item XXX-some-platform
299 =head1 Internal Changes
301 XXX Changes which affect the interface available to C<XS> code go here.
302 Other significant internal changes for future core maintainers should
305 [ List each change as a =item entry ]
315 =head1 Selected Bug Fixes
317 XXX Important bug fixes in the core language are summarised here.
318 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
319 L</Modules and Pragmata>.
321 [ List each fix as a =item entry ]
331 =head1 Known Problems
333 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
334 tests that had to be C<TODO>ed for the release would be noted here, unless
335 they were specific to a particular platform (see below).
337 This is a list of some significant unfixed bugs, which are regressions
338 from either 5.XXX.XXX or 5.XXX.XXX.
340 [ List each fix as a =item entry ]
352 XXX If any significant core contributor has died, we've added a short obituary
355 =head1 Acknowledgements
357 XXX Generate this with:
359 perl Porting/acknowledgements.pl v5.17.0..HEAD
361 =head1 Reporting Bugs
363 If you find what you think is a bug, you might check the articles
364 recently posted to the comp.lang.perl.misc newsgroup and the perl
365 bug database at http://rt.perl.org/perlbug/ . There may also be
366 information at http://www.perl.org/ , the Perl Home Page.
368 If you believe you have an unreported bug, please run the L<perlbug>
369 program included with your release. Be sure to trim your bug down
370 to a tiny but sufficient test case. Your bug report, along with the
371 output of C<perl -V>, will be sent off to perlbug@perl.org to be
372 analysed by the Perl porting team.
374 If the bug you are reporting has security implications, which make it
375 inappropriate to send to a publicly archived mailing list, then please send
376 it to perl5-security-report@perl.org. This points to a closed subscription
377 unarchived mailing list, which includes
378 all the core committers, who will be able
379 to help assess the impact of issues, figure out a resolution, and help
380 co-ordinate the release of patches to mitigate or fix the problem across all
381 platforms on which Perl is supported. Please only use this address for
382 security issues in the Perl core, not for modules independently
387 The F<Changes> file for an explanation of how to view exhaustive details
390 The F<INSTALL> file for how to build Perl.
392 The F<README> file for general stuff.
394 The F<Artistic> and F<Copying> files for copyright information.