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