Commit | Line | Data |
---|---|---|
44691e6f AB |
1 | =encoding utf8 |
2 | ||
3 | =head1 NAME | |
4 | ||
4380f76d KE |
5 | [ this is a template for a new perldelta file. Any text flagged as XXX needs |
6 | to be processed before release. ] | |
7 | ||
8 | perldelta - what is new for perl v5.29.6 | |
e4c43fa1 | 9 | |
4026b091 S |
10 | =head1 DESCRIPTION |
11 | ||
4380f76d | 12 | This document describes differences between the 5.29.5 release and the 5.29.6 |
4026b091 S |
13 | release. |
14 | ||
4380f76d KE |
15 | If you are upgrading from an earlier release such as 5.29.4, first read |
16 | L<perl5295delta>, which describes differences between 5.29.4 and 5.29.5. | |
17 | ||
18 | =head1 Notice | |
19 | ||
20 | XXX Any important notices here | |
4234ac96 | 21 | |
21d34e95 JSA |
22 | =head1 Core Enhancements |
23 | ||
4380f76d KE |
24 | XXX New core language features go here. Summarize user-visible core language |
25 | enhancements. Particularly prominent performance optimisations could go | |
26 | here, but most should go in the L</Performance Enhancements> section. | |
dafb2544 | 27 | |
4380f76d | 28 | [ List each enhancement as a =head2 entry ] |
dafb2544 | 29 | |
4380f76d | 30 | =head1 Security |
4234ac96 | 31 | |
4380f76d KE |
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. | |
747c94ed | 35 | |
4380f76d KE |
36 | [ List each security issue as a =head2 entry ] |
37 | ||
38 | =head1 Incompatible Changes | |
39 | ||
40 | XXX For a release on a stable branch, this section aspires to be: | |
41 | ||
42 | There are no changes intentionally incompatible with 5.XXX.XXX | |
43 | If any exist, they are bugs, and we request that you submit a | |
44 | report. See L</Reporting Bugs> below. | |
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 | ||
52 | =head2 Module removals | |
53 | ||
54 | XXX Remove this section if not applicable. | |
55 | ||
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. | |
60 | ||
61 | The core versions of these modules will now issue C<"deprecated">-category | |
62 | warnings to alert you to this fact. To silence these deprecation warnings, | |
63 | install the modules in question from CPAN. | |
64 | ||
65 | Note that these are (with rare exceptions) fine modules that you are encouraged | |
66 | to continue to use. Their disinclusion from core primarily hinges on their | |
67 | necessity to bootstrapping a fully functional, CPAN-capable Perl installation, | |
68 | not usually on concerns over their design. | |
69 | ||
70 | =over | |
747c94ed | 71 | |
4380f76d KE |
72 | =item XXX |
73 | ||
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. | |
747c94ed | 76 | |
4234ac96 | 77 | =back |
747c94ed | 78 | |
4380f76d | 79 | [ List each other deprecation as a =head2 entry ] |
747c94ed | 80 | |
4380f76d KE |
81 | =head1 Performance Enhancements |
82 | ||
83 | XXX Changes which enhance performance without changing behaviour go here. | |
84 | There may well be none in a stable release. | |
85 | ||
86 | [ List each enhancement as an =item entry ] | |
295a484e | 87 | |
21d34e95 | 88 | =over 4 |
928a385c KE |
89 | |
90 | =item * | |
91 | ||
4380f76d | 92 | XXX |
21d34e95 | 93 | |
4380f76d KE |
94 | =back |
95 | ||
96 | =head1 Modules and Pragmata | |
21d34e95 | 97 | |
4380f76d KE |
98 | XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/> |
99 | go here. If Module::CoreList is updated, generate an initial draft of the | |
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. | |
21d34e95 | 103 | |
4380f76d KE |
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.) | |
21d34e95 | 109 | |
4380f76d | 110 | [ Within each section, list entries as an =item entry ] |
21d34e95 | 111 | |
4380f76d | 112 | =head2 New Modules and Pragmata |
21d34e95 | 113 | |
4380f76d | 114 | =over 4 |
4234ac96 | 115 | |
15f62f05 | 116 | =item * |
4234ac96 | 117 | |
4380f76d | 118 | XXX Remove this section if not applicable. |
21d34e95 | 119 | |
4380f76d KE |
120 | =back |
121 | ||
122 | =head2 Updated Modules and Pragmata | |
21d34e95 | 123 | |
4380f76d | 124 | =over 4 |
4234ac96 | 125 | |
15f62f05 | 126 | =item * |
4234ac96 | 127 | |
4380f76d | 128 | L<XXX> has been upgraded from version A.xx to B.yy. |
4234ac96 | 129 | |
4380f76d KE |
130 | If there was something important to note about this change, include that here. |
131 | ||
132 | =back | |
4234ac96 | 133 | |
4380f76d KE |
134 | =head2 Removed Modules and Pragmata |
135 | ||
136 | =over 4 | |
21d34e95 | 137 | |
8de8eb77 | 138 | =item * |
21d34e95 | 139 | |
4380f76d | 140 | XXX |
4234ac96 AC |
141 | |
142 | =back | |
143 | ||
15f62f05 | 144 | =head1 Documentation |
4234ac96 | 145 | |
4380f76d KE |
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 | ||
149 | =head2 New Documentation | |
150 | ||
151 | XXX Changes which create B<new> files in F<pod/> go here. | |
152 | ||
153 | =head3 L<XXX> | |
154 | ||
155 | XXX Description of the purpose of the new file here | |
156 | ||
15f62f05 | 157 | =head2 Changes to Existing Documentation |
4234ac96 | 158 | |
15f62f05 KE |
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>. | |
4234ac96 | 162 | |
4380f76d KE |
163 | XXX Changes which significantly change existing files in F<pod/> go here. |
164 | However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics> | |
165 | section. | |
166 | ||
15f62f05 KE |
167 | Additionally, the following selected changes have been made: |
168 | ||
4380f76d | 169 | =head3 L<XXX> |
4234ac96 AC |
170 | |
171 | =over 4 | |
21d34e95 | 172 | |
8de8eb77 | 173 | =item * |
21d34e95 | 174 | |
4380f76d KE |
175 | XXX Description of the change here |
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 | ||
185 | XXX New or changed warnings emitted by the core's C<C> code go here. Also | |
186 | include any changes in L<perldiag> that reconcile it to the C<C> code. | |
187 | ||
188 | =head2 New Diagnostics | |
189 | ||
190 | XXX Newly added diagnostic messages go under here, separated into New Errors | |
191 | and New Warnings | |
192 | ||
193 | =head3 New Errors | |
194 | ||
195 | =over 4 | |
196 | ||
197 | =item * | |
198 | ||
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"> | |
210 | ||
211 | =back | |
212 | ||
213 | =head2 Changes to Existing Diagnostics | |
214 | ||
215 | XXX Changes (i.e. rewording) of diagnostic messages go here | |
216 | ||
217 | =over 4 | |
218 | ||
219 | =item * | |
220 | ||
221 | XXX Describe change here | |
222 | ||
223 | =back | |
224 | ||
225 | =head1 Utility Changes | |
226 | ||
227 | XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here. | |
228 | Most of these are built within the directory F<utils>. | |
229 | ||
230 | [ List utility changes as a =head2 entry for each utility and =item | |
231 | entries for each change | |
232 | Use L<XXX> with program names to get proper documentation linking. ] | |
233 | ||
234 | =head2 L<XXX> | |
235 | ||
236 | =over 4 | |
237 | ||
238 | =item * | |
239 | ||
240 | XXX | |
4234ac96 AC |
241 | |
242 | =back | |
243 | ||
244 | =head1 Configuration and Compilation | |
245 | ||
4380f76d KE |
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 | ||
251 | [ List changes as an =item entry ]. | |
252 | ||
4234ac96 | 253 | =over 4 |
21d34e95 | 254 | |
8de8eb77 | 255 | =item * |
21d34e95 | 256 | |
4380f76d | 257 | XXX |
4234ac96 AC |
258 | |
259 | =back | |
260 | ||
261 | =head1 Testing | |
262 | ||
4380f76d KE |
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). | |
266 | Changes to existing files in F<t/> aren't worth summarizing, although the bugs | |
267 | that they represent may be covered elsewhere. | |
268 | ||
269 | XXX If there were no significant test changes, say this: | |
270 | ||
4234ac96 AC |
271 | Tests were added and changed to reflect the other additions and changes |
272 | in this release. | |
273 | ||
4380f76d KE |
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 | ||
280 | [ List each test improvement as an =item entry ] | |
281 | ||
282 | =over 4 | |
283 | ||
284 | =item * | |
285 | ||
286 | XXX | |
287 | ||
288 | =back | |
289 | ||
4234ac96 AC |
290 | =head1 Platform Support |
291 | ||
4380f76d KE |
292 | XXX Any changes to platform support should be listed in the sections below. |
293 | ||
294 | [ Within the sections, list each platform as an =item entry with specific | |
295 | changes as paragraphs below it. ] | |
296 | ||
297 | =head2 New Platforms | |
298 | ||
299 | XXX List any platforms that this version of perl compiles on, that previous | |
300 | versions did not. These will either be enabled by new files in the F<hints/> | |
301 | directories, or new subdirectories and F<README> files at the top level of the | |
302 | source tree. | |
4234ac96 | 303 | |
4234ac96 AC |
304 | =over 4 |
305 | ||
4380f76d | 306 | =item XXX-some-platform |
4234ac96 | 307 | |
4380f76d | 308 | XXX |
61911ec2 | 309 | |
4380f76d KE |
310 | =back |
311 | ||
312 | =head2 Discontinued Platforms | |
61911ec2 | 313 | |
4380f76d | 314 | XXX List any platforms that this version of perl no longer compiles on. |
61911ec2 | 315 | |
4380f76d | 316 | =over 4 |
21d34e95 | 317 | |
4380f76d | 318 | =item XXX-some-platform |
21d34e95 | 319 | |
4380f76d | 320 | XXX |
7a54f67e CBW |
321 | |
322 | =back | |
323 | ||
4380f76d KE |
324 | =head2 Platform-Specific Notes |
325 | ||
326 | XXX List any changes for specific platforms. This could include configuration | |
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. | |
7a54f67e | 330 | |
7a54f67e CBW |
331 | =over 4 |
332 | ||
4380f76d KE |
333 | =item XXX-some-platform |
334 | ||
335 | XXX | |
336 | ||
337 | =back | |
338 | ||
339 | =head1 Internal Changes | |
340 | ||
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. | |
7a54f67e | 344 | |
4380f76d KE |
345 | [ List each change as an =item entry ] |
346 | ||
347 | =over 4 | |
21d34e95 | 348 | |
10056dd2 TC |
349 | =item * |
350 | ||
4380f76d KE |
351 | XXX |
352 | ||
353 | =back | |
354 | ||
355 | =head1 Selected Bug Fixes | |
356 | ||
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>. | |
359 | ||
360 | [ List each fix as an =item entry ] | |
361 | ||
362 | =over 4 | |
10056dd2 | 363 | |
ea89b333 DM |
364 | =item * |
365 | ||
4380f76d | 366 | XXX |
ea89b333 | 367 | |
4380f76d | 368 | =back |
ea89b333 | 369 | |
4380f76d | 370 | =head1 Known Problems |
ea89b333 | 371 | |
4380f76d KE |
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 | |
374 | platform specific bugs also go here. | |
ea89b333 | 375 | |
4380f76d KE |
376 | [ List each fix as an =item entry ] |
377 | ||
378 | =over 4 | |
379 | ||
380 | =item * | |
381 | ||
382 | XXX | |
ea89b333 | 383 | |
373fec1e SH |
384 | =back |
385 | ||
4380f76d KE |
386 | =head1 Errata From Previous Releases |
387 | ||
388 | =over 4 | |
21d34e95 | 389 | |
4380f76d KE |
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. | |
7a54f67e | 394 | |
4380f76d | 395 | =back |
21d34e95 | 396 | |
4380f76d | 397 | =head1 Obituary |
4234ac96 | 398 | |
4380f76d KE |
399 | XXX If any significant core contributor or member of the CPAN community has |
400 | died, add a short obituary here. | |
4234ac96 | 401 | |
4380f76d | 402 | =head1 Acknowledgements |
c4070876 | 403 | |
4380f76d | 404 | XXX Generate this with: |
c4070876 | 405 | |
4380f76d | 406 | perl Porting/acknowledgements.pl v5.29.5..HEAD |
f5b73711 | 407 | |
44691e6f AB |
408 | =head1 Reporting Bugs |
409 | ||
373fec1e | 410 | If you find what you think is a bug, you might check the perl bug database |
15f62f05 KE |
411 | at L<https://rt.perl.org/>. There may also be information at |
412 | L<http://www.perl.org/>, the Perl Home Page. | |
44691e6f | 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>, | |
b5cbfe35 | 417 | will be sent off to perlbug@perl.org to be analysed by the Perl porting team. |
44691e6f | 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 | |
373fec1e SH |
421 | L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION> |
422 | for details of how to report the issue. | |
44691e6f | 423 | |
390ae6f9 S |
424 | =head1 Give Thanks |
425 | ||
373fec1e SH |
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: | |
390ae6f9 S |
428 | |
429 | perlthanks | |
430 | ||
431 | This will send an email to the Perl 5 Porters list with your show of thanks. | |
432 | ||
44691e6f AB |
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. | |
44691e6f AB |
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 |