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 | ||
5cca4ae1 | 54 | XXX Remove this section if not applicable. |
c68b7fe2 | 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 | 85 | |
589c97f4 | 86 | [ List each enhancement as an =item entry ] |
be83b7f4 DG |
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 | |
84654b26 AC |
104 | The list of new and updated modules is modified automatically as part of |
105 | preparing a Perl release, so the only reason to manually add entries here is if | |
106 | you're summarising the important changes in the module update. (Also, if the | |
107 | manually-added details don't match the automatically-generated ones, the | |
108 | release manager will have to investigate the situation carefully.) | |
109 | ||
589c97f4 | 110 | [ Within each section, list entries as an =item entry ] |
be83b7f4 | 111 | |
57b3b745 DM |
112 | =head2 New Modules and Pragmata |
113 | ||
be83b7f4 | 114 | =over 4 |
57b3b745 | 115 | |
be83b7f4 | 116 | =item * |
57b3b745 | 117 | |
5cca4ae1 | 118 | XXX Remove this section if not applicable. |
57b3b745 | 119 | |
be83b7f4 | 120 | =back |
57b3b745 | 121 | |
be83b7f4 | 122 | =head2 Updated Modules and Pragmata |
57b3b745 DM |
123 | |
124 | =over 4 | |
125 | ||
be83b7f4 DG |
126 | =item * |
127 | ||
e08634c5 | 128 | L<XXX> has been upgraded from version A.xx to B.yy. |
be83b7f4 | 129 | |
5cca4ae1 KE |
130 | If there was something important to note about this change, include that here. |
131 | ||
be83b7f4 DG |
132 | =back |
133 | ||
134 | =head2 Removed Modules and Pragmata | |
135 | ||
136 | =over 4 | |
137 | ||
138 | =item * | |
57b3b745 DM |
139 | |
140 | XXX | |
141 | ||
142 | =back | |
143 | ||
be83b7f4 DG |
144 | =head1 Documentation |
145 | ||
146 | XXX Changes to files in F<pod/> go here. Consider grouping entries by | |
147 | file and be sure to link to the appropriate page, e.g. L<perlfunc>. | |
148 | ||
be83b7f4 | 149 | =head2 New Documentation |
57b3b745 DM |
150 | |
151 | XXX Changes which create B<new> files in F<pod/> go here. | |
152 | ||
6f56ac39 | 153 | =head3 L<XXX> |
57b3b745 | 154 | |
6f56ac39 | 155 | XXX Description of the purpose of the new file here |
57b3b745 | 156 | |
be83b7f4 | 157 | =head2 Changes to Existing Documentation |
57b3b745 | 158 | |
111750ba KW |
159 | We have attempted to update the documentation to reflect the changes |
160 | listed in this document. If you find any we have missed, send email | |
161 | to L<perlbug@perl.org|mailto:perlbug@perl.org>. | |
162 | ||
57b3b745 | 163 | XXX Changes which significantly change existing files in F<pod/> go here. |
be83b7f4 DG |
164 | However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics> |
165 | section. | |
57b3b745 | 166 | |
111750ba KW |
167 | Additionally, the following selected changes have been made: |
168 | ||
6f56ac39 DG |
169 | =head3 L<XXX> |
170 | ||
be83b7f4 | 171 | =over 4 |
57b3b745 | 172 | |
6f56ac39 | 173 | =item * |
57b3b745 | 174 | |
6f56ac39 | 175 | XXX Description of the change here |
be83b7f4 DG |
176 | |
177 | =back | |
178 | ||
179 | =head1 Diagnostics | |
180 | ||
181 | The following additions or changes have been made to diagnostic output, | |
182 | including warnings and fatal error messages. For the complete list of | |
183 | diagnostic messages, see L<perldiag>. | |
184 | ||
e08634c5 | 185 | XXX New or changed warnings emitted by the core's C<C> code go here. Also |
be83b7f4 DG |
186 | include any changes in L<perldiag> that reconcile it to the C<C> code. |
187 | ||
be83b7f4 DG |
188 | =head2 New Diagnostics |
189 | ||
e08634c5 SH |
190 | XXX Newly added diagnostic messages go under here, separated into New Errors |
191 | and New Warnings | |
57b3b745 | 192 | |
18a6db11 DG |
193 | =head3 New Errors |
194 | ||
57b3b745 DM |
195 | =over 4 |
196 | ||
197 | =item * | |
198 | ||
18a6db11 DG |
199 | XXX L<message|perldiag/"message"> |
200 | ||
201 | =back | |
202 | ||
203 | =head3 New Warnings | |
204 | ||
205 | =over 4 | |
206 | ||
207 | =item * | |
208 | ||
209 | XXX L<message|perldiag/"message"> | |
57b3b745 DM |
210 | |
211 | =back | |
212 | ||
be83b7f4 | 213 | =head2 Changes to Existing Diagnostics |
57b3b745 | 214 | |
be83b7f4 | 215 | XXX Changes (i.e. rewording) of diagnostic messages go here |
57b3b745 | 216 | |
be83b7f4 DG |
217 | =over 4 |
218 | ||
219 | =item * | |
57b3b745 | 220 | |
18a6db11 | 221 | XXX Describe change here |
57b3b745 | 222 | |
be83b7f4 DG |
223 | =back |
224 | ||
225 | =head1 Utility Changes | |
226 | ||
e08634c5 | 227 | XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here. |
eb561242 | 228 | Most of these are built within the directory F<utils>. |
be83b7f4 | 229 | |
ca3178e0 | 230 | [ List utility changes as a =head2 entry for each utility and =item |
6f56ac39 DG |
231 | entries for each change |
232 | Use L<XXX> with program names to get proper documentation linking. ] | |
233 | ||
ca3178e0 | 234 | =head2 L<XXX> |
be83b7f4 DG |
235 | |
236 | =over 4 | |
237 | ||
6f56ac39 | 238 | =item * |
57b3b745 DM |
239 | |
240 | XXX | |
241 | ||
be83b7f4 DG |
242 | =back |
243 | ||
244 | =head1 Configuration and Compilation | |
245 | ||
246 | XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools | |
247 | go here. Any other changes to the Perl build process should be listed here. | |
248 | However, any platform-specific changes should be listed in the | |
249 | L</Platform Support> section, instead. | |
250 | ||
589c97f4 | 251 | [ List changes as an =item entry ]. |
57b3b745 DM |
252 | |
253 | =over 4 | |
254 | ||
be83b7f4 | 255 | =item * |
57b3b745 DM |
256 | |
257 | XXX | |
258 | ||
259 | =back | |
260 | ||
be83b7f4 | 261 | =head1 Testing |
57b3b745 | 262 | |
be83b7f4 DG |
263 | XXX Any significant changes to the testing of a freshly built perl should be |
264 | listed here. Changes which create B<new> files in F<t/> go here as do any | |
265 | large changes to the testing harness (e.g. when parallel testing was added). | |
e08634c5 | 266 | Changes to existing files in F<t/> aren't worth summarizing, although the bugs |
be83b7f4 DG |
267 | that they represent may be covered elsewhere. |
268 | ||
111750ba KW |
269 | XXX If there were no significant test changes, say this: |
270 | ||
271 | Tests were added and changed to reflect the other additions and changes | |
272 | in this release. | |
273 | ||
274 | XXX If instead there were significant changes, say this: | |
275 | ||
276 | Tests were added and changed to reflect the other additions and | |
277 | changes in this release. Furthermore, these significant changes were | |
278 | made: | |
279 | ||
589c97f4 | 280 | [ List each test improvement as an =item entry ] |
57b3b745 DM |
281 | |
282 | =over 4 | |
283 | ||
284 | =item * | |
285 | ||
286 | XXX | |
287 | ||
288 | =back | |
289 | ||
be83b7f4 DG |
290 | =head1 Platform Support |
291 | ||
292 | XXX Any changes to platform support should be listed in the sections below. | |
293 | ||
589c97f4 | 294 | [ Within the sections, list each platform as an =item entry with specific |
be83b7f4 DG |
295 | changes as paragraphs below it. ] |
296 | ||
297 | =head2 New Platforms | |
57b3b745 | 298 | |
be83b7f4 | 299 | XXX List any platforms that this version of perl compiles on, that previous |
e08634c5 | 300 | versions did not. These will either be enabled by new files in the F<hints/> |
be83b7f4 DG |
301 | directories, or new subdirectories and F<README> files at the top level of the |
302 | source tree. | |
57b3b745 DM |
303 | |
304 | =over 4 | |
305 | ||
be83b7f4 | 306 | =item XXX-some-platform |
57b3b745 DM |
307 | |
308 | XXX | |
309 | ||
310 | =back | |
311 | ||
be83b7f4 | 312 | =head2 Discontinued Platforms |
57b3b745 | 313 | |
be83b7f4 | 314 | XXX List any platforms that this version of perl no longer compiles on. |
57b3b745 DM |
315 | |
316 | =over 4 | |
317 | ||
be83b7f4 | 318 | =item XXX-some-platform |
57b3b745 DM |
319 | |
320 | XXX | |
321 | ||
322 | =back | |
323 | ||
be83b7f4 | 324 | =head2 Platform-Specific Notes |
57b3b745 | 325 | |
e08634c5 | 326 | XXX List any changes for specific platforms. This could include configuration |
be83b7f4 DG |
327 | and compilation changes or changes in portability/compatibility. However, |
328 | changes within modules for platforms should generally be listed in the | |
329 | L</Modules and Pragmata> section. | |
57b3b745 DM |
330 | |
331 | =over 4 | |
332 | ||
be83b7f4 | 333 | =item XXX-some-platform |
57b3b745 DM |
334 | |
335 | XXX | |
336 | ||
337 | =back | |
338 | ||
be83b7f4 | 339 | =head1 Internal Changes |
57b3b745 | 340 | |
e08634c5 SH |
341 | XXX Changes which affect the interface available to C<XS> code go here. Other |
342 | significant internal changes for future core maintainers should be noted as | |
343 | well. | |
57b3b745 | 344 | |
589c97f4 | 345 | [ List each change as an =item entry ] |
57b3b745 DM |
346 | |
347 | =over 4 | |
348 | ||
349 | =item * | |
350 | ||
351 | XXX | |
352 | ||
353 | =back | |
354 | ||
be83b7f4 | 355 | =head1 Selected Bug Fixes |
57b3b745 | 356 | |
e08634c5 SH |
357 | XXX Important bug fixes in the core language are summarized here. Bug fixes in |
358 | files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>. | |
57b3b745 | 359 | |
589c97f4 | 360 | [ List each fix as an =item entry ] |
57b3b745 DM |
361 | |
362 | =over 4 | |
363 | ||
364 | =item * | |
365 | ||
366 | XXX | |
367 | ||
368 | =back | |
369 | ||
be83b7f4 | 370 | =head1 Known Problems |
57b3b745 | 371 | |
e08634c5 SH |
372 | XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any |
373 | tests that had to be C<TODO>ed for the release would be noted here. Unfixed | |
8ef13de7 | 374 | platform specific bugs also go here. |
be83b7f4 | 375 | |
589c97f4 | 376 | [ List each fix as an =item entry ] |
be83b7f4 DG |
377 | |
378 | =over 4 | |
379 | ||
380 | =item * | |
381 | ||
382 | XXX | |
383 | ||
384 | =back | |
57b3b745 | 385 | |
ca587180 YO |
386 | =head1 Errata From Previous Releases |
387 | ||
388 | =over 4 | |
389 | ||
390 | =item * | |
391 | ||
392 | XXX Add anything here that we forgot to add, or were mistaken about, in | |
393 | the perldelta of a previous release. | |
394 | ||
395 | =back | |
396 | ||
345e2394 | 397 | =head1 Obituary |
57b3b745 | 398 | |
5cca4ae1 KE |
399 | XXX If any significant core contributor or member of the CPAN community has |
400 | died, add a short obituary here. | |
57b3b745 DM |
401 | |
402 | =head1 Acknowledgements | |
403 | ||
f1c1ecab | 404 | XXX Generate this with: |
548e9a3a | 405 | |
e44d60b6 | 406 | perl Porting/acknowledgements.pl v5.27.9..HEAD |
57b3b745 | 407 | |
57b3b745 DM |
408 | =head1 Reporting Bugs |
409 | ||
32356571 DC |
410 | If you find what you think is a bug, you might check the perl bug database |
411 | at L<https://rt.perl.org/> . There may also be information at | |
6b8ca0cc | 412 | L<http://www.perl.org/> , the Perl Home Page. |
57b3b745 | 413 | |
e08634c5 SH |
414 | If you believe you have an unreported bug, please run the L<perlbug> program |
415 | included with your release. Be sure to trim your bug down to a tiny but | |
416 | sufficient test case. Your bug report, along with the output of C<perl -V>, | |
417 | will be sent off to perlbug@perl.org to be analysed by the Perl porting team. | |
57b3b745 | 418 | |
87c118b9 DM |
419 | If the bug you are reporting has security implications which make it |
420 | inappropriate to send to a publicly archived mailing list, then see | |
421 | L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION> | |
422 | for details of how to report the issue. | |
57b3b745 | 423 | |
390ae6f9 S |
424 | =head1 Give Thanks |
425 | ||
426 | If you wish to thank the Perl 5 Porters for the work we had done in Perl 5, | |
427 | you can do so by running the C<perlthanks> program: | |
428 | ||
429 | perlthanks | |
430 | ||
431 | This will send an email to the Perl 5 Porters list with your show of thanks. | |
432 | ||
57b3b745 DM |
433 | =head1 SEE ALSO |
434 | ||
e08634c5 SH |
435 | The F<Changes> file for an explanation of how to view exhaustive details on |
436 | what changed. | |
57b3b745 DM |
437 | |
438 | The F<INSTALL> file for how to build Perl. | |
439 | ||
440 | The F<README> file for general stuff. | |
441 | ||
442 | The F<Artistic> and F<Copying> files for copyright information. | |
443 | ||
444 | =cut |