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