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