Commit | Line | Data |
---|---|---|
44691e6f AB |
1 | =encoding utf8 |
2 | ||
3 | =head1 NAME | |
4 | ||
d1a156bb MH |
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.31.9 | |
d407e309 | 9 | |
862f380b | 10 | =head1 DESCRIPTION |
261e14b0 | 11 | |
d1a156bb | 12 | This document describes differences between the 5.31.8 release and the 5.31.9 |
862f380b | 13 | release. |
261e14b0 | 14 | |
d1a156bb MH |
15 | If you are upgrading from an earlier release such as 5.31.7, first read |
16 | L<perl5318delta>, which describes differences between 5.31.7 and 5.31.8. | |
9629ca98 N |
17 | |
18 | =head1 Notice | |
19 | ||
d1a156bb | 20 | XXX Any important notices here |
65c3f050 | 21 | |
d1a156bb | 22 | =head1 Core Enhancements |
be2eb09e | 23 | |
d1a156bb MH |
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. | |
ced2c819 | 27 | |
d1a156bb | 28 | [ List each enhancement as a =head2 entry ] |
ced2c819 | 29 | |
d1a156bb | 30 | =head1 Security |
87fd4a59 | 31 | |
d1a156bb MH |
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. | |
87fd4a59 | 35 | |
d1a156bb | 36 | [ List each security issue as a =head2 entry ] |
87fd4a59 | 37 | |
d1a156bb | 38 | =head1 Incompatible Changes |
87fd4a59 | 39 | |
d1a156bb | 40 | XXX For a release on a stable branch, this section aspires to be: |
ced2c819 | 41 | |
d1a156bb MH |
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. | |
46a21c0a | 45 | |
d1a156bb | 46 | [ List each incompatible change as a =head2 entry ] |
65c3f050 | 47 | |
d1a156bb | 48 | =head1 Deprecations |
149c28f9 | 49 | |
d1a156bb | 50 | XXX Any deprecated features, syntax, modules etc. should be listed here. |
c40875b7 | 51 | |
d1a156bb | 52 | =head2 Module removals |
cd42a730 | 53 | |
d1a156bb | 54 | XXX Remove this section if not applicable. |
1945661d | 55 | |
d1a156bb MH |
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. | |
65c3f050 | 60 | |
d1a156bb MH |
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. | |
cd42a730 | 64 | |
d1a156bb MH |
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. | |
ced2c819 | 69 | |
d1a156bb | 70 | =over |
ced2c819 | 71 | |
d1a156bb | 72 | =item XXX |
cf54f0ad | 73 | |
d1a156bb MH |
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. | |
149c28f9 | 76 | |
d1a156bb | 77 | =back |
ced2c819 | 78 | |
d1a156bb | 79 | [ List each other deprecation as a =head2 entry ] |
cf54f0ad | 80 | |
d1a156bb | 81 | =head1 Performance Enhancements |
fcbec156 | 82 | |
d1a156bb MH |
83 | XXX Changes which enhance performance without changing behaviour go here. |
84 | There may well be none in a stable release. | |
b5599884 | 85 | |
d1a156bb | 86 | [ List each enhancement as an =item entry ] |
77b20e67 | 87 | |
d1a156bb | 88 | =over 4 |
77b20e67 | 89 | |
5c2513ee JK |
90 | =item * |
91 | ||
d1a156bb | 92 | XXX |
5c2513ee | 93 | |
d1a156bb | 94 | =back |
a4aa12d5 | 95 | |
d1a156bb | 96 | =head1 Modules and Pragmata |
bad3a436 | 97 | |
d1a156bb MH |
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. | |
bad3a436 | 103 | |
d1a156bb MH |
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.) | |
cf54f0ad | 109 | |
d1a156bb | 110 | [ Within each section, list entries as an =item entry ] |
b5599884 | 111 | |
d1a156bb | 112 | =head2 New Modules and Pragmata |
46a21c0a | 113 | |
d1a156bb | 114 | =over 4 |
cf54f0ad MH |
115 | |
116 | =item * | |
117 | ||
d1a156bb | 118 | XXX Remove this section if not applicable. |
336e728b | 119 | |
9629ca98 | 120 | =back |
149c28f9 | 121 | |
d1a156bb | 122 | =head2 Updated Modules and Pragmata |
87fd4a59 MH |
123 | |
124 | =over 4 | |
125 | ||
126 | =item * | |
127 | ||
d1a156bb | 128 | L<XXX> has been upgraded from version A.xx to B.yy. |
87fd4a59 | 129 | |
d1a156bb | 130 | If there was something important to note about this change, include that here. |
87fd4a59 | 131 | |
d1a156bb | 132 | =back |
87fd4a59 | 133 | |
d1a156bb | 134 | =head2 Removed Modules and Pragmata |
87fd4a59 | 135 | |
d1a156bb | 136 | =over 4 |
87fd4a59 MH |
137 | |
138 | =item * | |
139 | ||
d1a156bb | 140 | XXX |
87fd4a59 MH |
141 | |
142 | =back | |
143 | ||
d1a156bb | 144 | =head1 Documentation |
87fd4a59 | 145 | |
d1a156bb MH |
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>. | |
87fd4a59 | 148 | |
d1a156bb | 149 | =head2 New Documentation |
87fd4a59 | 150 | |
d1a156bb | 151 | XXX Changes which create B<new> files in F<pod/> go here. |
87fd4a59 | 152 | |
d1a156bb | 153 | =head3 L<XXX> |
87fd4a59 | 154 | |
d1a156bb | 155 | XXX Description of the purpose of the new file here |
87fd4a59 | 156 | |
d1a156bb | 157 | =head2 Changes to Existing Documentation |
87fd4a59 | 158 | |
d1a156bb MH |
159 | We have attempted to update the documentation to reflect the changes |
160 | listed in this document. If you find any we have missed, open an issue | |
161 | at L<https://github.com/Perl/perl5/issues>. | |
87fd4a59 | 162 | |
d1a156bb MH |
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. | |
87fd4a59 | 166 | |
d1a156bb | 167 | Additionally, the following selected changes have been made: |
cfbe7727 | 168 | |
d1a156bb | 169 | =head3 L<XXX> |
87fd4a59 MH |
170 | |
171 | =over 4 | |
172 | ||
173 | =item * | |
174 | ||
6c245260 TC |
175 | Links to the now defunct L<https://search.cpan.org> site now point at |
176 | the equivalent L<https://metacpan.org> URL. [GH #17393] | |
87fd4a59 MH |
177 | |
178 | =back | |
179 | ||
d1a156bb | 180 | =head1 Diagnostics |
87fd4a59 | 181 | |
d1a156bb MH |
182 | The following additions or changes have been made to diagnostic output, |
183 | including warnings and fatal error messages. For the complete list of | |
184 | diagnostic messages, see L<perldiag>. | |
87fd4a59 | 185 | |
d1a156bb MH |
186 | XXX New or changed warnings emitted by the core's C<C> code go here. Also |
187 | include any changes in L<perldiag> that reconcile it to the C<C> code. | |
87fd4a59 | 188 | |
d1a156bb | 189 | =head2 New Diagnostics |
87fd4a59 | 190 | |
d1a156bb MH |
191 | XXX Newly added diagnostic messages go under here, separated into New Errors |
192 | and New Warnings | |
87fd4a59 | 193 | |
d1a156bb | 194 | =head3 New Errors |
87fd4a59 MH |
195 | |
196 | =over 4 | |
197 | ||
198 | =item * | |
199 | ||
d1a156bb | 200 | XXX L<message|perldiag/"message"> |
87fd4a59 MH |
201 | |
202 | =back | |
203 | ||
d1a156bb | 204 | =head3 New Warnings |
87fd4a59 MH |
205 | |
206 | =over 4 | |
207 | ||
208 | =item * | |
209 | ||
d1a156bb | 210 | XXX L<message|perldiag/"message"> |
87fd4a59 MH |
211 | |
212 | =back | |
213 | ||
d1a156bb | 214 | =head2 Changes to Existing Diagnostics |
04d3d25b | 215 | |
d1a156bb | 216 | XXX Changes (i.e. rewording) of diagnostic messages go here |
04d3d25b | 217 | |
d1a156bb | 218 | =over 4 |
87fd4a59 MH |
219 | |
220 | =item * | |
221 | ||
d1a156bb | 222 | XXX Describe change here |
fcbec156 | 223 | |
9629ca98 | 224 | =back |
65c3f050 | 225 | |
d1a156bb | 226 | =head1 Utility Changes |
46a21c0a | 227 | |
d1a156bb MH |
228 | XXX Changes to installed programs such as F<perldoc> and F<xsubpp> go here. |
229 | Most of these are built within the directory F<utils>. | |
46a21c0a | 230 | |
d1a156bb MH |
231 | [ List utility changes as a =head2 entry for each utility and =item |
232 | entries for each change | |
233 | Use L<XXX> with program names to get proper documentation linking. ] | |
234 | ||
235 | =head2 L<XXX> | |
9629ca98 | 236 | |
65c3f050 | 237 | =over 4 |
74c14c97 | 238 | |
9629ca98 | 239 | =item * |
46a21c0a | 240 | |
d1a156bb | 241 | XXX |
65c3f050 | 242 | |
9629ca98 | 243 | =back |
46a21c0a | 244 | |
9629ca98 | 245 | =head1 Configuration and Compilation |
46a21c0a | 246 | |
d1a156bb MH |
247 | XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools |
248 | go here. Any other changes to the Perl build process should be listed here. | |
249 | However, any platform-specific changes should be listed in the | |
250 | L</Platform Support> section, instead. | |
251 | ||
252 | [ List changes as an =item entry ]. | |
253 | ||
149c28f9 | 254 | =over 4 |
74c14c97 | 255 | |
9629ca98 | 256 | =item * |
fcbec156 | 257 | |
d1a156bb | 258 | XXX |
65c3f050 | 259 | |
d1a156bb | 260 | =back |
65c3f050 | 261 | |
d1a156bb | 262 | =head1 Testing |
65c3f050 | 263 | |
d1a156bb MH |
264 | XXX Any significant changes to the testing of a freshly built perl should be |
265 | listed here. Changes which create B<new> files in F<t/> go here as do any | |
266 | large changes to the testing harness (e.g. when parallel testing was added). | |
267 | Changes to existing files in F<t/> aren't worth summarizing, although the bugs | |
268 | that they represent may be covered elsewhere. | |
65c3f050 | 269 | |
d1a156bb | 270 | XXX If there were no significant test changes, say this: |
65c3f050 | 271 | |
d1a156bb MH |
272 | Tests were added and changed to reflect the other additions and changes |
273 | in this release. | |
65c3f050 | 274 | |
d1a156bb | 275 | XXX If instead there were significant changes, say this: |
9629ca98 N |
276 | |
277 | Tests were added and changed to reflect the other additions and | |
278 | changes in this release. Furthermore, these significant changes were | |
279 | made: | |
280 | ||
d1a156bb MH |
281 | [ List each test improvement as an =item entry ] |
282 | ||
149c28f9 | 283 | =over 4 |
65c3f050 | 284 | |
9629ca98 | 285 | =item * |
65c3f050 | 286 | |
d1a156bb | 287 | XXX |
65c3f050 | 288 | |
149c28f9 | 289 | =back |
65c3f050 | 290 | |
9629ca98 | 291 | =head1 Platform Support |
65c3f050 | 292 | |
d1a156bb | 293 | XXX Any changes to platform support should be listed in the sections below. |
65c3f050 | 294 | |
d1a156bb MH |
295 | [ Within the sections, list each platform as an =item entry with specific |
296 | changes as paragraphs below it. ] | |
061637ca | 297 | |
d1a156bb | 298 | =head2 New Platforms |
285db695 | 299 | |
d1a156bb MH |
300 | XXX List any platforms that this version of perl compiles on, that previous |
301 | versions did not. These will either be enabled by new files in the F<hints/> | |
302 | directories, or new subdirectories and F<README> files at the top level of the | |
303 | source tree. | |
87fd4a59 | 304 | |
d1a156bb | 305 | =over 4 |
87fd4a59 | 306 | |
d1a156bb | 307 | =item XXX-some-platform |
87fd4a59 | 308 | |
d1a156bb | 309 | XXX |
46a21c0a | 310 | |
65c3f050 CBW |
311 | =back |
312 | ||
d1a156bb MH |
313 | =head2 Discontinued Platforms |
314 | ||
315 | XXX List any platforms that this version of perl no longer compiles on. | |
65c3f050 | 316 | |
9629ca98 | 317 | =over 4 |
f3496246 | 318 | |
d1a156bb | 319 | =item XXX-some-platform |
149c28f9 | 320 | |
d1a156bb | 321 | XXX |
65c3f050 | 322 | |
149c28f9 | 323 | =back |
65c3f050 | 324 | |
d1a156bb MH |
325 | =head2 Platform-Specific Notes |
326 | ||
327 | XXX List any changes for specific platforms. This could include configuration | |
328 | and compilation changes or changes in portability/compatibility. However, | |
329 | changes within modules for platforms should generally be listed in the | |
330 | L</Modules and Pragmata> section. | |
65c3f050 | 331 | |
65c3f050 | 332 | =over 4 |
a1e5b700 | 333 | |
d1a156bb | 334 | =item XXX-some-platform |
a1e5b700 | 335 | |
d1a156bb | 336 | XXX |
87fd4a59 | 337 | |
d1a156bb | 338 | =back |
87fd4a59 | 339 | |
d1a156bb | 340 | =head1 Internal Changes |
87fd4a59 | 341 | |
d1a156bb MH |
342 | XXX Changes which affect the interface available to C<XS> code go here. Other |
343 | significant internal changes for future core maintainers should be noted as | |
344 | well. | |
87fd4a59 | 345 | |
d1a156bb MH |
346 | [ List each change as an =item entry ] |
347 | ||
348 | =over 4 | |
87fd4a59 MH |
349 | |
350 | =item * | |
351 | ||
d1a156bb | 352 | XXX |
87fd4a59 | 353 | |
d1a156bb | 354 | =back |
87fd4a59 | 355 | |
d1a156bb MH |
356 | =head1 Selected Bug Fixes |
357 | ||
358 | XXX Important bug fixes in the core language are summarized here. Bug fixes in | |
359 | files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>. | |
87fd4a59 | 360 | |
d1a156bb | 361 | [ List each fix as an =item entry ] |
87fd4a59 | 362 | |
d1a156bb | 363 | =over 4 |
87fd4a59 MH |
364 | |
365 | =item * | |
366 | ||
d1a156bb | 367 | XXX |
87fd4a59 | 368 | |
d1a156bb | 369 | =back |
87fd4a59 | 370 | |
d1a156bb MH |
371 | =head1 Known Problems |
372 | ||
373 | XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any | |
374 | tests that had to be C<TODO>ed for the release would be noted here. Unfixed | |
375 | platform specific bugs also go here. | |
376 | ||
377 | [ List each fix as an =item entry ] | |
87fd4a59 | 378 | |
d1a156bb MH |
379 | =over 4 |
380 | ||
381 | =item * | |
87fd4a59 | 382 | |
d1a156bb | 383 | XXX |
a1e5b700 | 384 | |
46a21c0a SH |
385 | =back |
386 | ||
d1a156bb | 387 | =head1 Errata From Previous Releases |
f3d30b53 | 388 | |
d1a156bb | 389 | =over 4 |
2852b67a | 390 | |
d1a156bb | 391 | =item * |
2852b67a | 392 | |
d1a156bb MH |
393 | XXX Add anything here that we forgot to add, or were mistaken about, in |
394 | the perldelta of a previous release. | |
2852b67a | 395 | |
d1a156bb | 396 | =back |
2852b67a | 397 | |
d1a156bb MH |
398 | =head1 Obituary |
399 | ||
400 | XXX If any significant core contributor or member of the CPAN community has | |
401 | died, add a short obituary here. | |
402 | ||
403 | =head1 Acknowledgements | |
2852b67a | 404 | |
d1a156bb | 405 | XXX Generate this with: |
2852b67a | 406 | |
d1a156bb | 407 | perl Porting/acknowledgements.pl v5.31.8..HEAD |
8424e368 | 408 | |
44691e6f AB |
409 | =head1 Reporting Bugs |
410 | ||
46a21c0a | 411 | If you find what you think is a bug, you might check the perl bug database |
8034715d | 412 | at L<https://github.com/Perl/perl5/issues>. There may also be information at |
46a21c0a | 413 | L<http://www.perl.org/>, the Perl Home Page. |
44691e6f | 414 | |
8166b4e0 DB |
415 | If you believe you have an unreported bug, please open an issue at |
416 | L<https://github.com/Perl/perl5/issues>. Be sure to trim your bug down to a | |
417 | tiny but sufficient test case. | |
44691e6f | 418 | |
87c118b9 | 419 | If the bug you are reporting has security implications which make it |
8166b4e0 | 420 | inappropriate to send to a public issue tracker, then see |
46a21c0a 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 | ||
46a21c0a 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 |