Commit | Line | Data |
---|---|---|
44691e6f AB |
1 | =encoding utf8 |
2 | ||
3 | =head1 NAME | |
4 | ||
cf73ceda 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.23.2 | |
eabfc7bc | 9 | |
2cfe9b50 | 10 | =head1 DESCRIPTION |
eabfc7bc | 11 | |
cf73ceda | 12 | This document describes differences between the 5.23.1 release and the 5.23.2 |
2cfe9b50 | 13 | release. |
eabfc7bc | 14 | |
cf73ceda MH |
15 | If you are upgrading from an earlier release such as 5.23.0, first read |
16 | L<perl5231delta>, which describes differences between 5.23.0 and 5.23.1. | |
17 | ||
18 | =head1 Notice | |
19 | ||
20 | XXX Any important notices here | |
fc4c3cec | 21 | |
2cfe9b50 | 22 | =head1 Core Enhancements |
eabfc7bc | 23 | |
cf73ceda 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. | |
deaaea8c | 27 | |
cf73ceda | 28 | [ List each enhancement as a =head2 entry ] |
deaaea8c | 29 | |
cf73ceda | 30 | =head1 Security |
deaaea8c | 31 | |
cf73ceda 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. | |
deaaea8c | 35 | |
cf73ceda | 36 | [ List each security issue as a =head2 entry ] |
deaaea8c | 37 | |
cf73ceda | 38 | =head1 Incompatible Changes |
deaaea8c | 39 | |
cf73ceda | 40 | XXX For a release on a stable branch, this section aspires to be: |
fb7e9cdd | 41 | |
cf73ceda 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. | |
fb7e9cdd | 45 | |
cf73ceda | 46 | [ List each incompatible change as a =head2 entry ] |
deaaea8c | 47 | |
cf73ceda | 48 | =head1 Deprecations |
7d380357 | 49 | |
cf73ceda | 50 | XXX Any deprecated features, syntax, modules etc. should be listed here. |
7d380357 | 51 | |
cf73ceda | 52 | =head2 Module removals |
0d610ac1 | 53 | |
cf73ceda | 54 | XXX Remove this section if inapplicable. |
0d610ac1 | 55 | |
cf73ceda 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. | |
eabfc7bc | 60 | |
cf73ceda 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. | |
26230909 | 64 | |
cf73ceda 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. | |
fc4c3cec | 69 | |
cf73ceda MH |
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 ] | |
fc4c3cec | 87 | |
f282dc56 | 88 | =over 4 |
fc4c3cec | 89 | |
f282dc56 | 90 | =item * |
fc4c3cec | 91 | |
cf73ceda | 92 | XXX |
fc4c3cec | 93 | |
cf73ceda | 94 | =back |
fc4c3cec | 95 | |
cf73ceda | 96 | =head1 Modules and Pragmata |
fc4c3cec | 97 | |
cf73ceda 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. | |
fc4c3cec | 103 | |
cf73ceda | 104 | [ Within each section, list entries as a =item entry ] |
fc4c3cec | 105 | |
cf73ceda | 106 | =head2 New Modules and Pragmata |
fc4c3cec | 107 | |
cf73ceda | 108 | =over 4 |
eabfc7bc | 109 | |
f282dc56 | 110 | =item * |
eabfc7bc | 111 | |
cf73ceda | 112 | XXX |
eabfc7bc | 113 | |
cf73ceda | 114 | =back |
eabfc7bc | 115 | |
cf73ceda MH |
116 | =head2 Updated Modules and Pragmata |
117 | ||
118 | =over 4 | |
eabfc7bc | 119 | |
73d6481e | 120 | =item * |
eabfc7bc | 121 | |
0dd5b0dc SH |
122 | L<Encode> has been upgraded from version 2.75 to 2.76. |
123 | ||
124 | =item * | |
125 | ||
a2373b32 TC |
126 | The PathTools module collection has been upgraded from version 3.55 to |
127 | 3.56. | |
128 | ||
129 | Minor optimizations. [perl #125712] | |
eabfc7bc | 130 | |
cf73ceda MH |
131 | =back |
132 | ||
133 | =head2 Removed Modules and Pragmata | |
eabfc7bc | 134 | |
cf73ceda | 135 | =over 4 |
eabfc7bc RS |
136 | |
137 | =item * | |
138 | ||
cf73ceda | 139 | XXX |
dc013420 | 140 | |
cf73ceda | 141 | =back |
dc013420 | 142 | |
cf73ceda | 143 | =head1 Documentation |
c85f23b2 | 144 | |
cf73ceda MH |
145 | XXX Changes to files in F<pod/> go here. Consider grouping entries by |
146 | file and be sure to link to the appropriate page, e.g. L<perlfunc>. | |
eabfc7bc | 147 | |
cf73ceda | 148 | =head2 New Documentation |
6962a25d | 149 | |
cf73ceda | 150 | XXX Changes which create B<new> files in F<pod/> go here. |
f282dc56 | 151 | |
cf73ceda | 152 | =head3 L<XXX> |
f282dc56 | 153 | |
cf73ceda | 154 | XXX Description of the purpose of the new file here |
f282dc56 | 155 | |
cf73ceda | 156 | =head2 Changes to Existing Documentation |
f282dc56 | 157 | |
cf73ceda MH |
158 | XXX Changes which significantly change existing files in F<pod/> go here. |
159 | However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics> | |
160 | section. | |
f282dc56 | 161 | |
cf73ceda | 162 | =head3 L<XXX> |
f282dc56 | 163 | |
cf73ceda | 164 | =over 4 |
f282dc56 MH |
165 | |
166 | =item * | |
167 | ||
cf73ceda MH |
168 | XXX Description of the change here |
169 | ||
170 | =back | |
171 | ||
172 | =head1 Diagnostics | |
173 | ||
174 | The following additions or changes have been made to diagnostic output, | |
175 | including warnings and fatal error messages. For the complete list of | |
176 | diagnostic messages, see L<perldiag>. | |
177 | ||
178 | XXX New or changed warnings emitted by the core's C<C> code go here. Also | |
179 | include any changes in L<perldiag> that reconcile it to the C<C> code. | |
180 | ||
181 | =head2 New Diagnostics | |
182 | ||
183 | XXX Newly added diagnostic messages go under here, separated into New Errors | |
184 | and New Warnings | |
185 | ||
186 | =head3 New Errors | |
187 | ||
188 | =over 4 | |
f282dc56 MH |
189 | |
190 | =item * | |
191 | ||
cf73ceda MH |
192 | XXX L<message|perldiag/"message"> |
193 | ||
194 | =back | |
195 | ||
196 | =head3 New Warnings | |
197 | ||
198 | =over 4 | |
f282dc56 MH |
199 | |
200 | =item * | |
201 | ||
cf73ceda MH |
202 | XXX L<message|perldiag/"message"> |
203 | ||
204 | =back | |
205 | ||
206 | =head2 Changes to Existing Diagnostics | |
207 | ||
208 | XXX Changes (i.e. rewording) of diagnostic messages go here | |
209 | ||
210 | =over 4 | |
6962a25d | 211 | |
0b8e4842 SH |
212 | =item * |
213 | ||
cf73ceda MH |
214 | XXX Describe change here |
215 | ||
216 | =back | |
217 | ||
218 | =head1 Utility Changes | |
219 | ||
220 | XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here. | |
221 | Most of these are built within the directory F<utils>. | |
222 | ||
223 | [ List utility changes as a =head2 entry for each utility and =item | |
224 | entries for each change | |
225 | Use L<XXX> with program names to get proper documentation linking. ] | |
226 | ||
227 | =head2 L<XXX> | |
228 | ||
229 | =over 4 | |
0b8e4842 | 230 | |
f282dc56 | 231 | =item * |
eabfc7bc | 232 | |
cf73ceda MH |
233 | XXX |
234 | ||
235 | =back | |
236 | ||
237 | =head1 Configuration and Compilation | |
238 | ||
239 | XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools | |
240 | go here. Any other changes to the Perl build process should be listed here. | |
241 | However, any platform-specific changes should be listed in the | |
242 | L</Platform Support> section, instead. | |
243 | ||
244 | [ List changes as a =item entry ]. | |
245 | ||
246 | =over 4 | |
374c951f SH |
247 | |
248 | =item * | |
249 | ||
cf73ceda | 250 | XXX |
e586de20 | 251 | |
fc4c3cec | 252 | =back |
e586de20 | 253 | |
cf73ceda | 254 | =head1 Testing |
b7b593d8 | 255 | |
cf73ceda MH |
256 | XXX Any significant changes to the testing of a freshly built perl should be |
257 | listed here. Changes which create B<new> files in F<t/> go here as do any | |
258 | large changes to the testing harness (e.g. when parallel testing was added). | |
259 | Changes to existing files in F<t/> aren't worth summarizing, although the bugs | |
260 | that they represent may be covered elsewhere. | |
b7b593d8 | 261 | |
cf73ceda | 262 | [ List each test improvement as a =item entry ] |
fc4c3cec | 263 | |
fc4c3cec | 264 | =over 4 |
4b951711 TC |
265 | |
266 | =item * | |
267 | ||
cf73ceda | 268 | XXX |
eabfc7bc | 269 | |
fc4c3cec | 270 | =back |
eabfc7bc | 271 | |
73d6481e | 272 | =head1 Platform Support |
eabfc7bc | 273 | |
cf73ceda MH |
274 | XXX Any changes to platform support should be listed in the sections below. |
275 | ||
276 | [ Within the sections, list each platform as a =item entry with specific | |
277 | changes as paragraphs below it. ] | |
278 | ||
279 | =head2 New Platforms | |
280 | ||
281 | XXX List any platforms that this version of perl compiles on, that previous | |
282 | versions did not. These will either be enabled by new files in the F<hints/> | |
283 | directories, or new subdirectories and F<README> files at the top level of the | |
284 | source tree. | |
9c0328ac | 285 | |
fc4c3cec RS |
286 | =over 4 |
287 | ||
cf73ceda | 288 | =item XXX-some-platform |
fc4c3cec | 289 | |
cf73ceda | 290 | XXX |
7d380357 | 291 | |
cf73ceda | 292 | =back |
7d380357 | 293 | |
cf73ceda MH |
294 | =head2 Discontinued Platforms |
295 | ||
296 | XXX List any platforms that this version of perl no longer compiles on. | |
297 | ||
298 | =over 4 | |
299 | ||
300 | =item XXX-some-platform | |
301 | ||
302 | XXX | |
7d380357 RS |
303 | |
304 | =back | |
eabfc7bc | 305 | |
cf73ceda MH |
306 | =head2 Platform-Specific Notes |
307 | ||
308 | XXX List any changes for specific platforms. This could include configuration | |
309 | and compilation changes or changes in portability/compatibility. However, | |
310 | changes within modules for platforms should generally be listed in the | |
311 | L</Modules and Pragmata> section. | |
312 | ||
313 | =over 4 | |
314 | ||
315 | =item XXX-some-platform | |
316 | ||
317 | XXX | |
318 | ||
2cfe9b50 | 319 | =back |
eabfc7bc | 320 | |
fc4c3cec RS |
321 | =head1 Internal Changes |
322 | ||
cf73ceda MH |
323 | XXX Changes which affect the interface available to C<XS> code go here. Other |
324 | significant internal changes for future core maintainers should be noted as | |
325 | well. | |
326 | ||
327 | [ List each change as a =item entry ] | |
328 | ||
2cfe9b50 | 329 | =over 4 |
eabfc7bc RS |
330 | |
331 | =item * | |
332 | ||
cf73ceda | 333 | XXX |
eabfc7bc | 334 | |
fc4c3cec | 335 | =back |
302ef3d4 | 336 | |
fc4c3cec | 337 | =head1 Selected Bug Fixes |
302ef3d4 | 338 | |
cf73ceda MH |
339 | XXX Important bug fixes in the core language are summarized here. Bug fixes in |
340 | files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>. | |
341 | ||
342 | [ List each fix as a =item entry ] | |
343 | ||
fc4c3cec | 344 | =over 4 |
eabfc7bc | 345 | |
73d6481e | 346 | =item * |
eabfc7bc | 347 | |
912fd711 KW |
348 | Perl can again be compiled with any Unicode version. This used to |
349 | (mostly) work, but was lost in v5.18 through v5.20. The property | |
350 | C<Name_Alias> did not exist prior to Unicode 5.0. L<Unicode::UCD> | |
351 | incorrectly said it did. This has been fixed. | |
cf73ceda MH |
352 | |
353 | =back | |
354 | ||
355 | =head1 Known Problems | |
356 | ||
357 | XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any | |
358 | tests that had to be C<TODO>ed for the release would be noted here. Unfixed | |
359 | platform specific bugs also go here. | |
360 | ||
361 | [ List each fix as a =item entry ] | |
362 | ||
363 | =over 4 | |
eabfc7bc | 364 | |
fc4c3cec | 365 | =item * |
2a7a05b4 | 366 | |
cf73ceda | 367 | XXX |
30aa8e3f | 368 | |
fc4c3cec | 369 | =back |
30aa8e3f | 370 | |
cf73ceda | 371 | =head1 Errata From Previous Releases |
2a7a05b4 | 372 | |
cf73ceda | 373 | =over 4 |
f282dc56 | 374 | |
cf73ceda | 375 | =item * |
f282dc56 | 376 | |
cf73ceda MH |
377 | XXX Add anything here that we forgot to add, or were mistaken about, in |
378 | the perldelta of a previous release. | |
f282dc56 | 379 | |
cf73ceda | 380 | =back |
f282dc56 | 381 | |
cf73ceda MH |
382 | =head1 Obituary |
383 | ||
384 | XXX If any significant core contributor has died, we've added a short obituary | |
385 | here. | |
386 | ||
387 | =head1 Acknowledgements | |
f282dc56 | 388 | |
cf73ceda | 389 | XXX Generate this with: |
2cfe9b50 | 390 | |
cf73ceda | 391 | perl Porting/acknowledgements.pl v5.23.1..HEAD |
f5b73711 | 392 | |
44691e6f AB |
393 | =head1 Reporting Bugs |
394 | ||
e08634c5 SH |
395 | If you find what you think is a bug, you might check the articles recently |
396 | posted to the comp.lang.perl.misc newsgroup and the perl bug database at | |
fc4c3cec RS |
397 | L<https://rt.perl.org/> . There may also be information at |
398 | L<http://www.perl.org/> , the Perl Home Page. | |
44691e6f | 399 | |
e08634c5 SH |
400 | If you believe you have an unreported bug, please run the L<perlbug> program |
401 | included with your release. Be sure to trim your bug down to a tiny but | |
402 | sufficient test case. Your bug report, along with the output of C<perl -V>, | |
403 | will be sent off to perlbug@perl.org to be analysed by the Perl porting team. | |
44691e6f AB |
404 | |
405 | If the bug you are reporting has security implications, which make it | |
e08634c5 SH |
406 | inappropriate to send to a publicly archived mailing list, then please send it |
407 | to perl5-security-report@perl.org. This points to a closed subscription | |
408 | unarchived mailing list, which includes all the core committers, who will be | |
409 | able to help assess the impact of issues, figure out a resolution, and help | |
f9001595 | 410 | co-ordinate the release of patches to mitigate or fix the problem across all |
e08634c5 SH |
411 | platforms on which Perl is supported. Please only use this address for |
412 | security issues in the Perl core, not for modules independently distributed on | |
413 | CPAN. | |
44691e6f AB |
414 | |
415 | =head1 SEE ALSO | |
416 | ||
e08634c5 SH |
417 | The F<Changes> file for an explanation of how to view exhaustive details on |
418 | what changed. | |
44691e6f AB |
419 | |
420 | The F<INSTALL> file for how to build Perl. | |
421 | ||
422 | The F<README> file for general stuff. | |
423 | ||
424 | The F<Artistic> and F<Copying> files for copyright information. | |
425 | ||
426 | =cut |