This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix transient pod infelicities spotted by podcheck.t
[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
99XXX
100
101=back
102
103=head2 Removed Modules and Pragmata
104
105=over 4
106
107=item *
57b3b745
DM
108
109XXX
110
111=back
112
be83b7f4
DG
113=head1 Documentation
114
115XXX Changes to files in F<pod/> go here. Consider grouping entries by
116file and be sure to link to the appropriate page, e.g. L<perlfunc>.
117
118[ Within each section, list entries as a =item entry ]
119
120=head2 New Documentation
57b3b745
DM
121
122XXX Changes which create B<new> files in F<pod/> go here.
123
124=over 4
125
126=item L<XXX>
127
128XXX
129
130=back
131
be83b7f4 132=head2 Changes to Existing Documentation
57b3b745
DM
133
134XXX Changes which significantly change existing files in F<pod/> go here.
be83b7f4
DG
135However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
136section.
57b3b745 137
be83b7f4 138=over 4
57b3b745 139
be83b7f4 140=item L<XXX>
57b3b745 141
be83b7f4
DG
142XXX
143
144=back
145
146=head1 Diagnostics
147
148The following additions or changes have been made to diagnostic output,
149including warnings and fatal error messages. For the complete list of
150diagnostic messages, see L<perldiag>.
151
152XXX New or changed warnings emitted by the core's C<C> code go here. Also
153include any changes in L<perldiag> that reconcile it to the C<C> code.
154
155[ Within each section, list entries as a =item entry ]
156
157=head2 New Diagnostics
158
159XXX Newly added diagnostic messages go here
57b3b745
DM
160
161=over 4
162
163=item *
164
165XXX
166
167=back
168
be83b7f4 169=head2 Changes to Existing Diagnostics
57b3b745 170
be83b7f4 171XXX Changes (i.e. rewording) of diagnostic messages go here
57b3b745 172
be83b7f4
DG
173=over 4
174
175=item *
57b3b745
DM
176
177XXX
178
be83b7f4
DG
179=back
180
181=head1 Utility Changes
182
183XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
184here. Most of these are built within the directories F<utils> and F<x2p>.
185
186[ List utility changes as a =item entry. Use L<XXX> with program names to get
187proper documentation linking. ]
188
189=over 4
190
191=item L<XXX>
57b3b745
DM
192
193XXX
194
be83b7f4
DG
195=back
196
197=head1 Configuration and Compilation
198
199XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
200go here. Any other changes to the Perl build process should be listed here.
201However, any platform-specific changes should be listed in the
202L</Platform Support> section, instead.
203
204[ List changes as a =item entry ].
57b3b745
DM
205
206=over 4
207
be83b7f4 208=item *
57b3b745
DM
209
210XXX
211
212=back
213
be83b7f4 214=head1 Testing
57b3b745 215
be83b7f4
DG
216XXX Any significant changes to the testing of a freshly built perl should be
217listed here. Changes which create B<new> files in F<t/> go here as do any
218large changes to the testing harness (e.g. when parallel testing was added).
219Changes to existing files in F<t/> aren't worth summarising, although the bugs
220that they represent may be covered elsewhere.
221
222[ List each test improvement as a =item entry ]
57b3b745
DM
223
224=over 4
225
226=item *
227
228XXX
229
230=back
231
be83b7f4
DG
232=head1 Platform Support
233
234XXX Any changes to platform support should be listed in the sections below.
235
236[ Within the sections, list each platform as a =item entry with specific
237changes as paragraphs below it. ]
238
239=head2 New Platforms
57b3b745 240
be83b7f4
DG
241XXX List any platforms that this version of perl compiles on, that previous
242versions did not. These will either be enabled by new files in the F<hints/>
243directories, or new subdirectories and F<README> files at the top level of the
244source tree.
57b3b745
DM
245
246=over 4
247
be83b7f4 248=item XXX-some-platform
57b3b745
DM
249
250XXX
251
252=back
253
be83b7f4 254=head2 Discontinued Platforms
57b3b745 255
be83b7f4 256XXX List any platforms that this version of perl no longer compiles on.
57b3b745
DM
257
258=over 4
259
be83b7f4 260=item XXX-some-platform
57b3b745
DM
261
262XXX
263
264=back
265
be83b7f4 266=head2 Platform-Specific Notes
57b3b745 267
be83b7f4
DG
268XXX List any changes for specific platforms. This could include configuration
269and compilation changes or changes in portability/compatibility. However,
270changes within modules for platforms should generally be listed in the
271L</Modules and Pragmata> section.
57b3b745
DM
272
273=over 4
274
be83b7f4 275=item XXX-some-platform
57b3b745
DM
276
277XXX
278
279=back
280
be83b7f4 281=head1 Internal Changes
57b3b745 282
be83b7f4
DG
283XXX Changes which affect the interface available to C<XS> code go here.
284Other significant internal changes for future core maintainers should
285be noted as well.
57b3b745 286
be83b7f4 287[ List each test improvement as a =item entry ]
57b3b745
DM
288
289=over 4
290
291=item *
292
293XXX
294
295=back
296
be83b7f4 297=head1 Selected Bug Fixes
57b3b745 298
be83b7f4
DG
299XXX Important bug fixes in the core language are summarised here.
300Bug fixes in files in F<ext/> and F<lib/> are best summarised in
301L</Modules and Pragmata>.
57b3b745 302
be83b7f4 303[ List each fix as a =item entry ]
57b3b745
DM
304
305=over 4
306
307=item *
308
309XXX
310
311=back
312
be83b7f4 313=head1 Known Problems
57b3b745 314
be83b7f4
DG
315XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
316tests that had to be C<TODO>ed for the release would be noted here, unless
317they were specific to a particular platform (see below).
318
319This is a list of some significant unfixed bugs, which are regressions
320from either 5.XXX.XXX or 5.XXX.XXX.
321
322[ List each fix as a =item entry ]
323
324=over 4
325
326=item *
327
328XXX
329
330=back
57b3b745 331
345e2394 332=head1 Obituary
57b3b745
DM
333
334XXX If any significant core contributor has died, we've added a short obituary
335here.
336
337=head1 Acknowledgements
338
339XXX The list of people to thank goes here.
340
57b3b745
DM
341=head1 Reporting Bugs
342
343If you find what you think is a bug, you might check the articles
344recently posted to the comp.lang.perl.misc newsgroup and the perl
345bug database at http://rt.perl.org/perlbug/ . There may also be
346information at http://www.perl.org/ , the Perl Home Page.
347
348If you believe you have an unreported bug, please run the B<perlbug>
349program included with your release. Be sure to trim your bug down
350to a tiny but sufficient test case. Your bug report, along with the
351output of C<perl -V>, will be sent off to perlbug@perl.org to be
352analysed by the Perl porting team.
353
354If the bug you are reporting has security implications, which make it
355inappropriate to send to a publicly archived mailing list, then please send
356it to perl5-security-report@perl.org. This points to a closed subscription
357unarchived mailing list, which includes all the core committers, who be able
358to help assess the impact of issues, figure out a resolution, and help
359co-ordinate the release of patches to mitigate or fix the problem across all
360platforms on which Perl is supported. Please only use this address for
361security issues in the Perl core, not for modules independently
362distributed on CPAN.
363
364=head1 SEE ALSO
365
366The F<Changes> file for an explanation of how to view exhaustive details
367on what changed.
368
369The F<INSTALL> file for how to build Perl.
370
371The F<README> file for general stuff.
372
373The F<Artistic> and F<Copying> files for copyright information.
374
375=cut