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