This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
"who be" should be "who are" in perldelta template
[perl5.git] / Porting / perldelta_template.pod
CommitLineData
bc7f466f
DM
1=encoding utf8
2
57b3b745
DM
3=head1 NAME
4
5[ this is a template for a new perldelta file. Any text flagged as
6XXX needs to be processed before release. ]
7
8perldelta - what is new for perl v5.XXX.XXX
9
10=head1 DESCRIPTION
11
12This document describes differences between the 5.XXX.XXX release and
13the 5.XXX.XXX release.
14
be83b7f4
DG
15If you are upgrading from an earlier release such as 5.YYY.YYY, first read
16L<perl5YYYdelta>, which describes differences between 5.ZZZ.ZZZ and
175.YYY.YYY.
57b3b745
DM
18
19=head1 Notice
20
21XXX Any important notices here
22
be83b7f4
DG
23=head1 Core Enhancements
24
25XXX New core language features go here. Summarise user-visible core language
26enhancements. Particularly prominent performance optimisations could go
27here, but most should go in the L</Performance Enhancements> section.
28
29[ List each enhancement as a =head2 entry ]
30
31=head1 Security
32
33XXX Any security-related notices go here. In particular, any security
34vulnerabilities closed should be noted here rather than in the
35L</Selected Bug Fixes> section.
36
37[ List each security issue as a =head2 entry ]
38
57b3b745
DM
39=head1 Incompatible Changes
40
41XXX For a release on a stable branch, this section aspires to be:
42
43 There are no changes intentionally incompatible with 5.XXX.XXX. If any
44 exist, they are bugs and reports are welcome.
45
be83b7f4 46[ List each incompatible change as a =head2 entry ]
57b3b745 47
be83b7f4 48=head1 Deprecations
57b3b745 49
be83b7f4
DG
50XXX Any deprecated features, syntax, modules etc. should be listed here.
51In particular, deprecated modules should be listed here even if they are
52listed as an updated module in the L</Modules and Pragmata> section.
57b3b745 53
be83b7f4 54[ List each deprecation as a =head2 entry ]
57b3b745 55
be83b7f4
DG
56=head1 Performance Enhancements
57
58XXX Changes which enhance performance without changing behaviour go here. There
59may well be none in a stable release.
60
61[ List each enhancement as a =item entry ]
62
63=over 4
64
65=item *
66
67XXX
68
69=back
57b3b745
DM
70
71=head1 Modules and Pragmata
72
42a0894d 73XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
88e14305
DG
74go here. If Module::CoreList is updated, generate an initial draft of the
75following sections using F<Porting/corelist-perldelta.pl>, which prints stub
76entries to STDOUT. Results can be pasted in place of the '=head2' entries
77below. A paragraph summary for important changes should then be added by hand.
78In an ideal world, dual-life modules would have a F<Changes> file that could be
79cribbed.
57b3b745 80
be83b7f4
DG
81[ Within each section, list entries as a =item entry ]
82
57b3b745
DM
83=head2 New Modules and Pragmata
84
be83b7f4 85=over 4
57b3b745 86
be83b7f4 87=item *
57b3b745 88
be83b7f4 89XXX
57b3b745 90
be83b7f4 91=back
57b3b745 92
be83b7f4 93=head2 Updated Modules and Pragmata
57b3b745
DM
94
95=over 4
96
be83b7f4
DG
97=item *
98
f95396b3
NC
99 [Verbatim block to avoid creating a bogus link]
100 L<XXX> has been upgraded from version 0.69 to version 0.70.
be83b7f4
DG
101
102=back
103
104=head2 Removed Modules and Pragmata
105
106=over 4
107
108=item *
57b3b745
DM
109
110XXX
111
112=back
113
be83b7f4
DG
114=head1 Documentation
115
116XXX Changes to files in F<pod/> go here. Consider grouping entries by
117file and be sure to link to the appropriate page, e.g. L<perlfunc>.
118
be83b7f4 119=head2 New Documentation
57b3b745
DM
120
121XXX Changes which create B<new> files in F<pod/> go here.
122
6f56ac39 123=head3 L<XXX>
57b3b745 124
6f56ac39 125XXX Description of the purpose of the new file here
57b3b745 126
be83b7f4 127=head2 Changes to Existing Documentation
57b3b745
DM
128
129XXX Changes which significantly change existing files in F<pod/> go here.
be83b7f4
DG
130However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
131section.
57b3b745 132
6f56ac39
DG
133=head3 L<XXX>
134
be83b7f4 135=over 4
57b3b745 136
6f56ac39 137=item *
57b3b745 138
6f56ac39 139XXX Description of the change here
be83b7f4
DG
140
141=back
142
143=head1 Diagnostics
144
145The following additions or changes have been made to diagnostic output,
146including warnings and fatal error messages. For the complete list of
147diagnostic messages, see L<perldiag>.
148
149XXX New or changed warnings emitted by the core's C<C> code go here. Also
150include any changes in L<perldiag> that reconcile it to the C<C> code.
151
18a6db11
DG
152[ Within each section, list entries as a =item entry that links to perldiag,
153 e.g.
154
155 =item *
156
157 L<Invalid version object|perldiag/"Invalid version object">
158]
be83b7f4
DG
159
160=head2 New Diagnostics
161
162XXX Newly added diagnostic messages go here
57b3b745 163
18a6db11
DG
164=head3 New Errors
165
57b3b745
DM
166=over 4
167
168=item *
169
18a6db11
DG
170XXX L<message|perldiag/"message">
171
172=back
173
174=head3 New Warnings
175
176=over 4
177
178=item *
179
180XXX L<message|perldiag/"message">
57b3b745
DM
181
182=back
183
be83b7f4 184=head2 Changes to Existing Diagnostics
57b3b745 185
be83b7f4 186XXX Changes (i.e. rewording) of diagnostic messages go here
57b3b745 187
be83b7f4
DG
188=over 4
189
190=item *
57b3b745 191
18a6db11 192XXX Describe change here
57b3b745 193
be83b7f4
DG
194=back
195
196=head1 Utility Changes
197
198XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
199here. Most of these are built within the directories F<utils> and F<x2p>.
200
6f56ac39
DG
201[ List utility changes as a =head3 entry for each utility and =item
202entries for each change
203Use L<XXX> with program names to get proper documentation linking. ]
204
205=head3 L<XXX>
be83b7f4
DG
206
207=over 4
208
6f56ac39 209=item *
57b3b745
DM
210
211XXX
212
be83b7f4
DG
213=back
214
215=head1 Configuration and Compilation
216
217XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
218go here. Any other changes to the Perl build process should be listed here.
219However, any platform-specific changes should be listed in the
220L</Platform Support> section, instead.
221
222[ List changes as a =item entry ].
57b3b745
DM
223
224=over 4
225
be83b7f4 226=item *
57b3b745
DM
227
228XXX
229
230=back
231
be83b7f4 232=head1 Testing
57b3b745 233
be83b7f4
DG
234XXX Any significant changes to the testing of a freshly built perl should be
235listed here. Changes which create B<new> files in F<t/> go here as do any
236large changes to the testing harness (e.g. when parallel testing was added).
237Changes to existing files in F<t/> aren't worth summarising, although the bugs
238that they represent may be covered elsewhere.
239
240[ List each test improvement as a =item entry ]
57b3b745
DM
241
242=over 4
243
244=item *
245
246XXX
247
248=back
249
be83b7f4
DG
250=head1 Platform Support
251
252XXX Any changes to platform support should be listed in the sections below.
253
254[ Within the sections, list each platform as a =item entry with specific
255changes as paragraphs below it. ]
256
257=head2 New Platforms
57b3b745 258
be83b7f4
DG
259XXX List any platforms that this version of perl compiles on, that previous
260versions did not. These will either be enabled by new files in the F<hints/>
261directories, or new subdirectories and F<README> files at the top level of the
262source tree.
57b3b745
DM
263
264=over 4
265
be83b7f4 266=item XXX-some-platform
57b3b745
DM
267
268XXX
269
270=back
271
be83b7f4 272=head2 Discontinued Platforms
57b3b745 273
be83b7f4 274XXX List any platforms that this version of perl no longer compiles on.
57b3b745
DM
275
276=over 4
277
be83b7f4 278=item XXX-some-platform
57b3b745
DM
279
280XXX
281
282=back
283
be83b7f4 284=head2 Platform-Specific Notes
57b3b745 285
be83b7f4
DG
286XXX List any changes for specific platforms. This could include configuration
287and compilation changes or changes in portability/compatibility. However,
288changes within modules for platforms should generally be listed in the
289L</Modules and Pragmata> section.
57b3b745
DM
290
291=over 4
292
be83b7f4 293=item XXX-some-platform
57b3b745
DM
294
295XXX
296
297=back
298
be83b7f4 299=head1 Internal Changes
57b3b745 300
be83b7f4
DG
301XXX Changes which affect the interface available to C<XS> code go here.
302Other significant internal changes for future core maintainers should
303be noted as well.
57b3b745 304
6fdf246e 305[ List each change as a =item entry ]
57b3b745
DM
306
307=over 4
308
309=item *
310
311XXX
312
313=back
314
be83b7f4 315=head1 Selected Bug Fixes
57b3b745 316
be83b7f4
DG
317XXX Important bug fixes in the core language are summarised here.
318Bug fixes in files in F<ext/> and F<lib/> are best summarised in
319L</Modules and Pragmata>.
57b3b745 320
be83b7f4 321[ List each fix as a =item entry ]
57b3b745
DM
322
323=over 4
324
325=item *
326
327XXX
328
329=back
330
be83b7f4 331=head1 Known Problems
57b3b745 332
be83b7f4
DG
333XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
334tests that had to be C<TODO>ed for the release would be noted here, unless
335they were specific to a particular platform (see below).
336
337This is a list of some significant unfixed bugs, which are regressions
338from either 5.XXX.XXX or 5.XXX.XXX.
339
340[ List each fix as a =item entry ]
341
342=over 4
343
344=item *
345
346XXX
347
348=back
57b3b745 349
345e2394 350=head1 Obituary
57b3b745
DM
351
352XXX If any significant core contributor has died, we've added a short obituary
353here.
354
355=head1 Acknowledgements
356
357XXX The list of people to thank goes here.
358
57b3b745
DM
359=head1 Reporting Bugs
360
361If you find what you think is a bug, you might check the articles
362recently posted to the comp.lang.perl.misc newsgroup and the perl
363bug database at http://rt.perl.org/perlbug/ . There may also be
364information at http://www.perl.org/ , the Perl Home Page.
365
7f89f796 366If you believe you have an unreported bug, please run the L<perlbug>
57b3b745
DM
367program included with your release. Be sure to trim your bug down
368to a tiny but sufficient test case. Your bug report, along with the
369output of C<perl -V>, will be sent off to perlbug@perl.org to be
370analysed by the Perl porting team.
371
372If the bug you are reporting has security implications, which make it
373inappropriate to send to a publicly archived mailing list, then please send
374it to perl5-security-report@perl.org. This points to a closed subscription
c4815ced 375unarchived mailing list, which includes all the core committers, who are able
57b3b745
DM
376to help assess the impact of issues, figure out a resolution, and help
377co-ordinate the release of patches to mitigate or fix the problem across all
378platforms on which Perl is supported. Please only use this address for
379security issues in the Perl core, not for modules independently
380distributed on CPAN.
381
382=head1 SEE ALSO
383
384The F<Changes> file for an explanation of how to view exhaustive details
385on what changed.
386
387The F<INSTALL> file for how to build Perl.
388
389The F<README> file for general stuff.
390
391The F<Artistic> and F<Copying> files for copyright information.
392
393=cut