Commit | Line | Data |
---|---|---|
44691e6f AB |
1 | =encoding utf8 |
2 | ||
3 | =head1 NAME | |
4 | ||
7065301c RS |
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.21.1 | |
c68523cb | 9 | |
238894db | 10 | =head1 DESCRIPTION |
c68523cb | 11 | |
7065301c | 12 | This document describes differences between the 5.21.0 release and the 5.21.1 |
238894db | 13 | release. |
c68523cb | 14 | |
7065301c RS |
15 | If you are upgrading from an earlier release such as 5.20.0, first read |
16 | L<perl5210delta>, which describes differences between 5.20.0 and 5.21.0. | |
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 ] | |
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 | ||
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 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 ] | |
87 | ||
88 | =over 4 | |
89 | ||
90 | =item * | |
91 | ||
92 | XXX | |
93 | ||
94 | =back | |
95 | ||
7ef8b31d | 96 | =head1 Modules and Pragmata |
f6f3144e | 97 | |
7065301c RS |
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. | |
103 | ||
104 | [ Within each section, list entries as a =item entry ] | |
105 | ||
106 | =head2 New Modules and Pragmata | |
24a38d90 RS |
107 | |
108 | =over 4 | |
109 | ||
110 | =item * | |
111 | ||
7065301c RS |
112 | XXX |
113 | ||
114 | =back | |
115 | ||
116 | =head2 Updated Modules and Pragmata | |
117 | ||
118 | =over 4 | |
24a38d90 RS |
119 | |
120 | =item * | |
121 | ||
56cdf413 TC |
122 | L<Carp> has been upgraded from version 1.3301 to 1.34. |
123 | ||
124 | Carp::Heavy now ignores version mismatches with Carp if Carp is newer | |
125 | than 1.12, since Carp::Heavy's guts were merged into Carp at that | |
126 | point. | |
127 | L<[perl #121574]|https://rt.perl.org/Ticket/Display.html?id=121574> | |
128 | ||
129 | =item * | |
130 | ||
4ed8f5ed TC |
131 | L<Math::BigInt> has been upgraded from version 1.9993 to 1.9994. |
132 | ||
133 | Synchronize POD changes from the CPAN release. | |
134 | ||
ee15bb65 TC |
135 | C<< Math::BigFloat->blog(x) >> would sometimes return blog(2*x) when |
136 | the accuracy was greater than 70 digits. | |
137 | ||
138 | The result of C<< Math::BigFloat->bdiv() >> in list context now | |
139 | satisfies C<< x = quotient * divisor + remainder >>. | |
140 | ||
4ed8f5ed TC |
141 | =item * |
142 | ||
234105dd TC |
143 | L<Math::BigRat> has been upgraded from version 0.2606 to 0.2607. |
144 | ||
145 | Synchronize POD changes from the CPAN release. | |
146 | ||
147 | =item * | |
148 | ||
c13fd1a2 TC |
149 | L<perl5db.pl> has been upgraded from version 1.44 to 1.45. |
150 | ||
151 | fork() in the debugger under C<tmux> will now create a new window for | |
891822fa TC |
152 | the forked process. L<[perl |
153 | #121333]|https://rt.perl.org/Ticket/Display.html?id=121333> | |
154 | ||
155 | The debugger now saves the current working directory on startup and | |
156 | restores it when you restart your program with C<R> or <rerun>. L<[perl | |
157 | #121509]|https://rt.perl.org/Ticket/Display.html?id=121509> | |
24a38d90 | 158 | |
f8187d97 SH |
159 | L<Unicode::Collate> has been upgraded from version 1.04 to 1.07. |
160 | ||
161 | Version 0.67's improved discontiguous contractions is invalidated by default | |
162 | and is supported as a parameter 'long_contraction'. | |
163 | ||
95f3e8d2 SH |
164 | =item * |
165 | ||
166 | L<Unicode::Normalize> has been upgraded from version 1.17 to 1.18. | |
167 | ||
168 | The XSUB implementation has been removed in favour of pure Perl. | |
169 | ||
238894db | 170 | =back |
24a38d90 | 171 | |
92fa985e | 172 | =head2 Removed Modules and Pragmata |
24a38d90 | 173 | |
238894db | 174 | =over 4 |
24a38d90 RS |
175 | |
176 | =item * | |
177 | ||
7065301c RS |
178 | XXX |
179 | ||
180 | =back | |
181 | ||
182 | =head1 Documentation | |
183 | ||
184 | XXX Changes to files in F<pod/> go here. Consider grouping entries by | |
185 | file and be sure to link to the appropriate page, e.g. L<perlfunc>. | |
186 | ||
187 | =head2 New Documentation | |
188 | ||
189 | XXX Changes which create B<new> files in F<pod/> go here. | |
190 | ||
191 | =head3 L<XXX> | |
192 | ||
193 | XXX Description of the purpose of the new file here | |
194 | ||
195 | =head2 Changes to Existing Documentation | |
196 | ||
197 | XXX Changes which significantly change existing files in F<pod/> go here. | |
198 | However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics> | |
199 | section. | |
200 | ||
201 | =head3 L<XXX> | |
202 | ||
203 | =over 4 | |
204 | ||
205 | =item * | |
206 | ||
207 | XXX Description of the change here | |
208 | ||
209 | =back | |
210 | ||
211 | =head1 Diagnostics | |
212 | ||
213 | The following additions or changes have been made to diagnostic output, | |
214 | including warnings and fatal error messages. For the complete list of | |
215 | diagnostic messages, see L<perldiag>. | |
216 | ||
217 | XXX New or changed warnings emitted by the core's C<C> code go here. Also | |
218 | include any changes in L<perldiag> that reconcile it to the C<C> code. | |
219 | ||
220 | =head2 New Diagnostics | |
221 | ||
222 | XXX Newly added diagnostic messages go under here, separated into New Errors | |
223 | and New Warnings | |
224 | ||
225 | =head3 New Errors | |
226 | ||
227 | =over 4 | |
24a38d90 RS |
228 | |
229 | =item * | |
230 | ||
7065301c RS |
231 | XXX L<message|perldiag/"message"> |
232 | ||
233 | =back | |
234 | ||
235 | =head3 New Warnings | |
236 | ||
237 | =over 4 | |
24a38d90 RS |
238 | |
239 | =item * | |
240 | ||
7065301c | 241 | XXX L<message|perldiag/"message"> |
24a38d90 | 242 | |
238894db | 243 | =back |
24a38d90 | 244 | |
7065301c | 245 | =head2 Changes to Existing Diagnostics |
24a38d90 | 246 | |
7065301c | 247 | XXX Changes (i.e. rewording) of diagnostic messages go here |
24a38d90 | 248 | |
7065301c RS |
249 | =over 4 |
250 | ||
251 | =item * | |
252 | ||
723edb96 TC |
253 | L<Unsuccessful %s on filename containing newline|perldiag/"Unsuccessful %s on filename containing newline"> |
254 | ||
255 | This warning is now only produced when the newline is at the end of | |
256 | the filename. | |
7065301c RS |
257 | |
258 | =back | |
259 | ||
260 | =head1 Utility Changes | |
261 | ||
262 | XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here. | |
263 | Most of these are built within the directories F<utils> and F<x2p>. | |
264 | ||
265 | [ List utility changes as a =head2 entry for each utility and =item | |
266 | entries for each change | |
267 | Use L<XXX> with program names to get proper documentation linking. ] | |
268 | ||
269 | =head2 L<XXX> | |
270 | ||
271 | =over 4 | |
272 | ||
273 | =item * | |
24a38d90 | 274 | |
7065301c RS |
275 | XXX |
276 | ||
277 | =back | |
278 | ||
279 | =head1 Configuration and Compilation | |
280 | ||
281 | XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools | |
282 | go here. Any other changes to the Perl build process should be listed here. | |
283 | However, any platform-specific changes should be listed in the | |
284 | L</Platform Support> section, instead. | |
285 | ||
286 | [ List changes as a =item entry ]. | |
287 | ||
288 | =over 4 | |
289 | ||
290 | =item * | |
291 | ||
292 | XXX | |
293 | ||
294 | =back | |
295 | ||
296 | =head1 Testing | |
297 | ||
298 | XXX Any significant changes to the testing of a freshly built perl should be | |
299 | listed here. Changes which create B<new> files in F<t/> go here as do any | |
300 | large changes to the testing harness (e.g. when parallel testing was added). | |
301 | Changes to existing files in F<t/> aren't worth summarizing, although the bugs | |
302 | that they represent may be covered elsewhere. | |
303 | ||
304 | [ List each test improvement as a =item entry ] | |
305 | ||
306 | =over 4 | |
307 | ||
308 | =item * | |
309 | ||
310 | XXX | |
311 | ||
312 | =back | |
313 | ||
314 | =head1 Platform Support | |
315 | ||
316 | XXX Any changes to platform support should be listed in the sections below. | |
317 | ||
318 | [ Within the sections, list each platform as a =item entry with specific | |
319 | changes as paragraphs below it. ] | |
320 | ||
321 | =head2 New Platforms | |
322 | ||
323 | XXX List any platforms that this version of perl compiles on, that previous | |
324 | versions did not. These will either be enabled by new files in the F<hints/> | |
325 | directories, or new subdirectories and F<README> files at the top level of the | |
326 | source tree. | |
327 | ||
328 | =over 4 | |
329 | ||
330 | =item XXX-some-platform | |
331 | ||
332 | XXX | |
333 | ||
334 | =back | |
335 | ||
336 | =head2 Discontinued Platforms | |
337 | ||
338 | XXX List any platforms that this version of perl no longer compiles on. | |
339 | ||
340 | =over 4 | |
341 | ||
342 | =item XXX-some-platform | |
343 | ||
344 | XXX | |
345 | ||
346 | =back | |
347 | ||
348 | =head2 Platform-Specific Notes | |
349 | ||
350 | XXX List any changes for specific platforms. This could include configuration | |
351 | and compilation changes or changes in portability/compatibility. However, | |
352 | changes within modules for platforms should generally be listed in the | |
353 | L</Modules and Pragmata> section. | |
354 | ||
355 | =over 4 | |
356 | ||
357 | =item XXX-some-platform | |
358 | ||
359 | XXX | |
360 | ||
361 | =back | |
362 | ||
363 | =head1 Internal Changes | |
364 | ||
365 | XXX Changes which affect the interface available to C<XS> code go here. Other | |
366 | significant internal changes for future core maintainers should be noted as | |
367 | well. | |
368 | ||
369 | [ List each change as a =item entry ] | |
370 | ||
371 | =over 4 | |
372 | ||
373 | =item * | |
374 | ||
375 | XXX | |
376 | ||
377 | =back | |
378 | ||
379 | =head1 Selected Bug Fixes | |
380 | ||
381 | XXX Important bug fixes in the core language are summarized here. Bug fixes in | |
382 | files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>. | |
383 | ||
384 | [ List each fix as a =item entry ] | |
385 | ||
386 | =over 4 | |
387 | ||
388 | =item * | |
389 | ||
30536d4a TC |
390 | index() and rindex() no longer crash when used on strings over 2GB in |
391 | size. | |
392 | L<[perl #121562]|https://rt.perl.org/Ticket/Display.html?id=121562>. | |
7065301c RS |
393 | |
394 | =back | |
395 | ||
396 | =head1 Known Problems | |
397 | ||
398 | XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any | |
399 | tests that had to be C<TODO>ed for the release would be noted here. Unfixed | |
400 | platform specific bugs also go here. | |
401 | ||
402 | [ List each fix as a =item entry ] | |
403 | ||
404 | =over 4 | |
405 | ||
406 | =item * | |
407 | ||
408 | XXX | |
409 | ||
410 | =back | |
411 | ||
412 | =head1 Errata From Previous Releases | |
413 | ||
414 | =over 4 | |
415 | ||
416 | =item * | |
417 | ||
418 | XXX Add anything here that we forgot to add, or were mistaken about, in | |
419 | the perldelta of a previous release. | |
420 | ||
421 | =back | |
422 | ||
423 | =head1 Obituary | |
424 | ||
425 | XXX If any significant core contributor has died, we've added a short obituary | |
426 | here. | |
427 | ||
428 | =head1 Acknowledgements | |
24a38d90 | 429 | |
7065301c | 430 | XXX Generate this with: |
52e02e68 | 431 | |
7065301c | 432 | perl Porting/acknowledgements.pl v5.21.1..HEAD |
f5b73711 | 433 | |
44691e6f AB |
434 | =head1 Reporting Bugs |
435 | ||
e08634c5 SH |
436 | If you find what you think is a bug, you might check the articles recently |
437 | posted to the comp.lang.perl.misc newsgroup and the perl bug database at | |
238894db | 438 | https://rt.perl.org/ . There may also be information at |
7ef8b31d | 439 | http://www.perl.org/ , the Perl Home Page. |
44691e6f | 440 | |
e08634c5 SH |
441 | If you believe you have an unreported bug, please run the L<perlbug> program |
442 | included with your release. Be sure to trim your bug down to a tiny but | |
443 | sufficient test case. Your bug report, along with the output of C<perl -V>, | |
444 | will be sent off to perlbug@perl.org to be analysed by the Perl porting team. | |
44691e6f AB |
445 | |
446 | If the bug you are reporting has security implications, which make it | |
e08634c5 SH |
447 | inappropriate to send to a publicly archived mailing list, then please send it |
448 | to perl5-security-report@perl.org. This points to a closed subscription | |
449 | unarchived mailing list, which includes all the core committers, who will be | |
450 | able to help assess the impact of issues, figure out a resolution, and help | |
f9001595 | 451 | co-ordinate the release of patches to mitigate or fix the problem across all |
e08634c5 SH |
452 | platforms on which Perl is supported. Please only use this address for |
453 | security issues in the Perl core, not for modules independently distributed on | |
454 | CPAN. | |
44691e6f AB |
455 | |
456 | =head1 SEE ALSO | |
457 | ||
e08634c5 SH |
458 | The F<Changes> file for an explanation of how to view exhaustive details on |
459 | what changed. | |
44691e6f AB |
460 | |
461 | The F<INSTALL> file for how to build Perl. | |
462 | ||
463 | The F<README> file for general stuff. | |
464 | ||
465 | The F<Artistic> and F<Copying> files for copyright information. | |
466 | ||
467 | =cut |