Commit | Line | Data |
---|---|---|
44691e6f AB |
1 | =encoding utf8 |
2 | ||
3 | =head1 NAME | |
4 | ||
262514fd SL |
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.25.6 | |
eabfc7bc | 9 | |
2cfe9b50 | 10 | =head1 DESCRIPTION |
eabfc7bc | 11 | |
262514fd | 12 | This document describes differences between the 5.25.5 release and the 5.25.6 |
4b8803f0 | 13 | release. |
f3ed8cbf | 14 | |
262514fd SL |
15 | If you are upgrading from an earlier release such as 5.25.4, first read |
16 | L<perl5255delta>, which describes differences between 5.25.4 and 5.25.5. | |
17 | ||
18 | =head1 Notice | |
19 | ||
20 | XXX Any important notices here | |
21 | ||
22 | =head1 Core Enhancements | |
23 | ||
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. | |
27 | ||
28 | [ List each enhancement as a =head2 entry ] | |
70f2a509 | 29 | |
be293293 | 30 | =head1 Security |
28aa987e | 31 | |
262514fd SL |
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. | |
5c0226f4 | 35 | |
262514fd | 36 | [ List each security issue as a =head2 entry ] |
28aa987e | 37 | |
262514fd | 38 | =head1 Incompatible Changes |
ce6646d7 | 39 | |
262514fd SL |
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 inapplicable. | |
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 | |
71 | ||
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. | |
76 | ||
77 | =back | |
78 | ||
79 | [ List each other deprecation as a =head2 entry ] | |
80 | ||
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 a =item entry ] | |
ce6646d7 | 87 | |
be293293 | 88 | =over 4 |
ce6646d7 | 89 | |
96f085e1 CBW |
90 | =item * |
91 | ||
262514fd | 92 | XXX |
2f8fe46a | 93 | |
262514fd | 94 | =back |
ce6646d7 | 95 | |
262514fd | 96 | =head1 Modules and Pragmata |
2c4879e2 | 97 | |
262514fd SL |
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. | |
2c4879e2 | 103 | |
262514fd | 104 | [ Within each section, list entries as a =item entry ] |
1608ed20 | 105 | |
262514fd SL |
106 | =head2 New Modules and Pragmata |
107 | ||
108 | =over 4 | |
1608ed20 SL |
109 | |
110 | =item * | |
111 | ||
262514fd | 112 | XXX |
1608ed20 | 113 | |
262514fd | 114 | =back |
1608ed20 | 115 | |
262514fd SL |
116 | =head2 Updated Modules and Pragmata |
117 | ||
118 | =over 4 | |
1608ed20 SL |
119 | |
120 | =item * | |
121 | ||
262514fd | 122 | L<XXX> has been upgraded from version A.xx to B.yy. |
1608ed20 | 123 | |
262514fd | 124 | =back |
ce6646d7 | 125 | |
262514fd | 126 | =head2 Removed Modules and Pragmata |
ce6646d7 | 127 | |
262514fd | 128 | =over 4 |
c0ea3294 | 129 | |
96f085e1 | 130 | =item * |
ce6646d7 | 131 | |
262514fd | 132 | XXX |
ce6646d7 | 133 | |
be293293 | 134 | =back |
8c3f6b0b | 135 | |
be293293 | 136 | =head1 Documentation |
8c3f6b0b | 137 | |
262514fd SL |
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 | ||
141 | =head2 New Documentation | |
142 | ||
143 | XXX Changes which create B<new> files in F<pod/> go here. | |
144 | ||
145 | =head3 L<XXX> | |
146 | ||
147 | XXX Description of the purpose of the new file here | |
148 | ||
be293293 | 149 | =head2 Changes to Existing Documentation |
e388eafa | 150 | |
262514fd SL |
151 | XXX Changes which significantly change existing files in F<pod/> go here. |
152 | However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics> | |
153 | section. | |
154 | ||
155 | =head3 L<XXX> | |
fb0f05f2 | 156 | |
be293293 | 157 | =over 4 |
e388eafa | 158 | |
96f085e1 | 159 | =item * |
e388eafa | 160 | |
262514fd | 161 | XXX Description of the change here |
2c4879e2 | 162 | |
be293293 | 163 | =back |
96f085e1 | 164 | |
262514fd SL |
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 | ||
171 | XXX New or changed warnings emitted by the core's C<C> code go here. Also | |
172 | include any changes in L<perldiag> that reconcile it to the C<C> code. | |
173 | ||
174 | =head2 New Diagnostics | |
175 | ||
176 | XXX Newly added diagnostic messages go under here, separated into New Errors | |
177 | and New Warnings | |
178 | ||
179 | =head3 New Errors | |
96f085e1 | 180 | |
efdbe372 | 181 | =over 4 |
bf1007bc | 182 | |
96f085e1 | 183 | =item * |
bf1007bc | 184 | |
262514fd | 185 | XXX L<message|perldiag/"message"> |
0302547a | 186 | |
228bfab9 | 187 | =back |
18940b1f | 188 | |
262514fd | 189 | =head3 New Warnings |
6674eaad | 190 | |
be293293 | 191 | =over 4 |
6674eaad | 192 | |
262514fd | 193 | =item * |
c0ea3294 | 194 | |
262514fd | 195 | XXX L<message|perldiag/"message"> |
483efd0a | 196 | |
262514fd SL |
197 | =back |
198 | ||
199 | =head2 Changes to Existing Diagnostics | |
483efd0a | 200 | |
262514fd SL |
201 | XXX Changes (i.e. rewording) of diagnostic messages go here |
202 | ||
203 | =over 4 | |
483efd0a | 204 | |
2c4879e2 SL |
205 | =item * |
206 | ||
262514fd | 207 | XXX Describe change here |
2c4879e2 SL |
208 | |
209 | =back | |
210 | ||
262514fd | 211 | =head1 Utility Changes |
2c4879e2 | 212 | |
262514fd SL |
213 | XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here. |
214 | Most of these are built within the directory F<utils>. | |
2c4879e2 | 215 | |
262514fd SL |
216 | [ List utility changes as a =head2 entry for each utility and =item |
217 | entries for each change | |
218 | Use L<XXX> with program names to get proper documentation linking. ] | |
219 | ||
220 | =head2 L<XXX> | |
2c4879e2 SL |
221 | |
222 | =over 4 | |
223 | ||
224 | =item * | |
225 | ||
262514fd | 226 | XXX |
2c4879e2 | 227 | |
483efd0a | 228 | =back |
866373cb | 229 | |
262514fd | 230 | =head1 Configuration and Compilation |
866373cb | 231 | |
262514fd SL |
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 ]. | |
97fd6880 | 238 | |
be293293 | 239 | =over 4 |
d5dece5d | 240 | |
7c26c031 FC |
241 | =item * |
242 | ||
262514fd | 243 | XXX |
07cfdfcc | 244 | |
262514fd | 245 | =back |
2c4879e2 | 246 | |
262514fd | 247 | =head1 Testing |
2c4879e2 | 248 | |
262514fd SL |
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). | |
252 | Changes to existing files in F<t/> aren't worth summarizing, although the bugs | |
253 | that they represent may be covered elsewhere. | |
07cfdfcc | 254 | |
262514fd | 255 | [ List each test improvement as a =item entry ] |
27368b5c | 256 | |
be293293 | 257 | =over 4 |
4b99cb86 | 258 | |
c61c589c FC |
259 | =item * |
260 | ||
262514fd | 261 | XXX |
7d897bd0 | 262 | |
262514fd | 263 | =back |
046a081f | 264 | |
262514fd | 265 | =head1 Platform Support |
046a081f | 266 | |
262514fd | 267 | XXX Any changes to platform support should be listed in the sections below. |
80d3c92b | 268 | |
262514fd SL |
269 | [ Within the sections, list each platform as a =item entry with specific |
270 | changes as paragraphs below it. ] | |
80d3c92b | 271 | |
262514fd | 272 | =head2 New Platforms |
190c14e6 | 273 | |
01f745b3 | 274 | A sub containing a "forward" declaration with the same name (e.g., |
190c14e6 FC |
275 | C<sub c { sub c; }>) could sometimes crash or loop infinitely. [perl |
276 | #129090] | |
277 | ||
262514fd | 278 | =over 4 |
abd589f7 | 279 | |
262514fd | 280 | =item XXX-some-platform |
abd589f7 | 281 | |
262514fd | 282 | XXX |
2c4879e2 | 283 | |
262514fd | 284 | =back |
2c4879e2 | 285 | |
262514fd | 286 | =head2 Discontinued Platforms |
2c4879e2 | 287 | |
262514fd | 288 | XXX List any platforms that this version of perl no longer compiles on. |
2c4879e2 | 289 | |
262514fd | 290 | =over 4 |
2c4879e2 | 291 | |
262514fd | 292 | =item XXX-some-platform |
2c4879e2 | 293 | |
262514fd | 294 | XXX |
2c4879e2 | 295 | |
262514fd | 296 | =back |
2c4879e2 | 297 | |
262514fd | 298 | =head2 Platform-Specific Notes |
2c4879e2 | 299 | |
262514fd SL |
300 | XXX List any changes for specific platforms. This could include configuration |
301 | and compilation changes or changes in portability/compatibility. However, | |
302 | changes within modules for platforms should generally be listed in the | |
303 | L</Modules and Pragmata> section. | |
2c4879e2 | 304 | |
262514fd | 305 | =over 4 |
2ad45e6f | 306 | |
262514fd | 307 | =item XXX-some-platform |
2ad45e6f | 308 | |
262514fd | 309 | XXX |
1608ed20 | 310 | |
262514fd | 311 | =back |
1608ed20 | 312 | |
262514fd | 313 | =head1 Internal Changes |
1608ed20 | 314 | |
262514fd SL |
315 | XXX Changes which affect the interface available to C<XS> code go here. Other |
316 | significant internal changes for future core maintainers should be noted as | |
317 | well. | |
1608ed20 | 318 | |
262514fd | 319 | [ List each change as a =item entry ] |
1608ed20 | 320 | |
262514fd | 321 | =over 4 |
1608ed20 | 322 | |
1608ed20 SL |
323 | =item * |
324 | ||
262514fd SL |
325 | XXX |
326 | ||
327 | =back | |
328 | ||
329 | =head1 Selected Bug Fixes | |
330 | ||
331 | XXX Important bug fixes in the core language are summarized here. Bug fixes in | |
332 | files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>. | |
333 | ||
334 | [ List each fix as a =item entry ] | |
335 | ||
336 | =over 4 | |
1608ed20 SL |
337 | |
338 | =item * | |
339 | ||
262514fd SL |
340 | XXX |
341 | ||
342 | =back | |
343 | ||
344 | =head1 Known Problems | |
345 | ||
346 | XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any | |
347 | tests that had to be C<TODO>ed for the release would be noted here. Unfixed | |
348 | platform specific bugs also go here. | |
349 | ||
350 | [ List each fix as a =item entry ] | |
351 | ||
352 | =over 4 | |
1608ed20 SL |
353 | |
354 | =item * | |
355 | ||
262514fd | 356 | XXX |
1608ed20 | 357 | |
be293293 | 358 | =back |
7d897bd0 | 359 | |
262514fd | 360 | =head1 Errata From Previous Releases |
24528e8e | 361 | |
262514fd | 362 | =over 4 |
24528e8e | 363 | |
262514fd | 364 | =item * |
24528e8e | 365 | |
262514fd SL |
366 | XXX Add anything here that we forgot to add, or were mistaken about, in |
367 | the perldelta of a previous release. | |
1a21f19e | 368 | |
262514fd | 369 | =back |
1a21f19e | 370 | |
262514fd | 371 | =head1 Obituary |
1a21f19e | 372 | |
262514fd SL |
373 | XXX If any significant core contributor has died, we've added a short obituary |
374 | here. | |
1a21f19e | 375 | |
262514fd | 376 | =head1 Acknowledgements |
1a21f19e | 377 | |
262514fd | 378 | XXX Generate this with: |
24528e8e | 379 | |
262514fd | 380 | perl Porting/acknowledgements.pl v5.25.5..HEAD |
f5b73711 | 381 | |
44691e6f AB |
382 | =head1 Reporting Bugs |
383 | ||
c0ea3294 SH |
384 | If you find what you think is a bug, you might check the perl bug database |
385 | at L<https://rt.perl.org/> . There may also be information at | |
4b8803f0 | 386 | L<http://www.perl.org/> , the Perl Home Page. |
44691e6f | 387 | |
e08634c5 SH |
388 | If you believe you have an unreported bug, please run the L<perlbug> program |
389 | included with your release. Be sure to trim your bug down to a tiny but | |
390 | sufficient test case. Your bug report, along with the output of C<perl -V>, | |
391 | will be sent off to perlbug@perl.org to be analysed by the Perl porting team. | |
44691e6f | 392 | |
87c118b9 DM |
393 | If the bug you are reporting has security implications which make it |
394 | inappropriate to send to a publicly archived mailing list, then see | |
c0ea3294 SH |
395 | L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION> |
396 | for details of how to report the issue. | |
44691e6f AB |
397 | |
398 | =head1 SEE ALSO | |
399 | ||
e08634c5 SH |
400 | The F<Changes> file for an explanation of how to view exhaustive details on |
401 | what changed. | |
44691e6f AB |
402 | |
403 | The F<INSTALL> file for how to build Perl. | |
404 | ||
405 | The F<README> file for general stuff. | |
406 | ||
407 | The F<Artistic> and F<Copying> files for copyright information. | |
408 | ||
409 | =cut |