This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
The VC6 Chainsaw Massacre
[perl5.git] / pod / perldelta.pod
1 =encoding utf8
2
3 =head1 NAME
4
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.31.5
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.31.4 release and the 5.31.5
13 release.
14
15 If you are upgrading from an earlier release such as 5.31.3, first read
16 L<perl5314delta>, which describes differences between 5.31.3 and 5.31.4.
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 =head2 Modifiable variables are no longer permitted in constants
49
50 Code like:
51
52     my $var;
53     $sub = sub () { $var };
54
55 where C<$var> is referenced elsewhere in some sort of modiable context
56 now produces an exception when the sub is defined.
57
58 This error can be avoided by adding a return to the sub definition:
59
60     $sub = sub () { return $var };
61
62 This has been deprecated since perl 5.22.
63
64 [perl #131138]
65
66 =head1 Deprecations
67
68 XXX Any deprecated features, syntax, modules etc. should be listed here.
69
70 =head2 Module removals
71
72 XXX Remove this section if not applicable.
73
74 The following modules will be removed from the core distribution in a
75 future release, and will at that time need to be installed from CPAN.
76 Distributions on CPAN which require these modules will need to list them as
77 prerequisites.
78
79 The core versions of these modules will now issue C<"deprecated">-category
80 warnings to alert you to this fact.  To silence these deprecation warnings,
81 install the modules in question from CPAN.
82
83 Note that these are (with rare exceptions) fine modules that you are encouraged
84 to continue to use.  Their disinclusion from core primarily hinges on their
85 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
86 not usually on concerns over their design.
87
88 =over
89
90 =item XXX
91
92 XXX Note that deprecated modules should be listed here even if they are listed
93 as an updated module in the L</Modules and Pragmata> section.
94
95 =back
96
97 [ List each other deprecation as a =head2 entry ]
98
99 =head1 Performance Enhancements
100
101 XXX Changes which enhance performance without changing behaviour go here.
102 There may well be none in a stable release.
103
104 [ List each enhancement as an =item entry ]
105
106 =over 4
107
108 =item *
109
110 XXX
111
112 =back
113
114 =head1 Modules and Pragmata
115
116 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
117 go here.  If Module::CoreList is updated, generate an initial draft of the
118 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
119 for important changes should then be added by hand.  In an ideal world,
120 dual-life modules would have a F<Changes> file that could be cribbed.
121
122 The list of new and updated modules is modified automatically as part of
123 preparing a Perl release, so the only reason to manually add entries here is if
124 you're summarising the important changes in the module update. (Also, if the
125 manually-added details don't match the automatically-generated ones, the
126 release manager will have to investigate the situation carefully.)
127
128 [ Within each section, list entries as an =item entry ]
129
130 =head2 New Modules and Pragmata
131
132 =over 4
133
134 =item *
135
136 XXX Remove this section if not applicable.
137
138 =back
139
140 =head2 Updated Modules and Pragmata
141
142 =over 4
143
144 =item *
145
146 L<XXX> has been upgraded from version A.xx to B.yy.
147
148 If there was something important to note about this change, include that here.
149
150 =item *
151
152 L<Dumpvalue> has been upgraded from version 1.18 to 1.21.
153
154 Previously, when dumping elements of an array and encountering an undefined
155 value, the string printed would have been C<empty array>.  This has been
156 changed to what was apparently originally intended:  C<empty slot>.
157
158 =back
159
160 =head2 Removed Modules and Pragmata
161
162 =over 4
163
164 =item *
165
166 XXX
167
168 =back
169
170 =head1 Documentation
171
172 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
173 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
174
175 =head2 New Documentation
176
177 XXX Changes which create B<new> files in F<pod/> go here.
178
179 =head3 L<XXX>
180
181 XXX Description of the purpose of the new file here
182
183 =head2 Changes to Existing Documentation
184
185 We have attempted to update the documentation to reflect the changes
186 listed in this document.  If you find any we have missed, send email
187 to L<perlbug@perl.org|mailto:perlbug@perl.org>.
188
189 XXX Changes which significantly change existing files in F<pod/> go here.
190 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
191 section.
192
193 Additionally, the following selected changes have been made:
194
195 =head3 URLs have been changed to https://, stale links updated
196
197 =over 4
198
199 =item *
200
201 Where applicable, the URLs in the documentation have been moved from
202 using the http:// protocol to https:// . This also affects the location
203 of the bug tracker at L<https://rt.perl.org>.
204
205 =item *
206
207 Some links to OS/2 libraries, Address Sanitizer and other system tools
208 had gone stale. These have been updated with working links.
209
210 =item *
211
212 Some links to old mails on perl5-porters had gone stale. These have been
213 updated with working links.
214
215 =back
216
217 =head3 L<XXX>
218
219 =over 4
220
221 =item *
222
223 XXX Description of the change here
224
225 =back
226
227 =head1 Diagnostics
228
229 The following additions or changes have been made to diagnostic output,
230 including warnings and fatal error messages.  For the complete list of
231 diagnostic messages, see L<perldiag>.
232
233 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
234 include any changes in L<perldiag> that reconcile it to the C<C> code.
235
236 =head2 New Diagnostics
237
238 XXX Newly added diagnostic messages go under here, separated into New Errors
239 and New Warnings
240
241 =head3 New Errors
242
243 =over 4
244
245 =item *
246
247 XXX L<message|perldiag/"message">
248
249 =back
250
251 =head3 New Warnings
252
253 =over 4
254
255 =item *
256
257 XXX L<message|perldiag/"message">
258
259 =back
260
261 =head2 Changes to Existing Diagnostics
262
263 XXX Changes (i.e. rewording) of diagnostic messages go here
264
265 =over 4
266
267 =item *
268
269 XXX Describe change here
270
271 =back
272
273 =head1 Utility Changes
274
275 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
276 Most of these are built within the directory F<utils>.
277
278 [ List utility changes as a =head2 entry for each utility and =item
279 entries for each change
280 Use L<XXX> with program names to get proper documentation linking. ]
281
282 =head2 L<XXX>
283
284 =over 4
285
286 =item *
287
288 XXX
289
290 =back
291
292 =head1 Configuration and Compilation
293
294 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
295 go here.  Any other changes to the Perl build process should be listed here.
296 However, any platform-specific changes should be listed in the
297 L</Platform Support> section, instead.
298
299 [ List changes as an =item entry ].
300
301 =over 4
302
303 =item *
304
305 Perl now no longer probes for C<d_u32align>, defaulting to C<define>
306 on all platforms.  This check was error prone when it was done, which
307 was on 32-bit platforms only.  [perl #133495]
308
309 =back
310
311 =head1 Testing
312
313 XXX Any significant changes to the testing of a freshly built perl should be
314 listed here.  Changes which create B<new> files in F<t/> go here as do any
315 large changes to the testing harness (e.g. when parallel testing was added).
316 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
317 that they represent may be covered elsewhere.
318
319 XXX If there were no significant test changes, say this:
320
321 Tests were added and changed to reflect the other additions and changes
322 in this release.
323
324 XXX If instead there were significant changes, say this:
325
326 Tests were added and changed to reflect the other additions and
327 changes in this release.  Furthermore, these significant changes were
328 made:
329
330 [ List each test improvement as an =item entry ]
331
332 =over 4
333
334 =item *
335
336 XXX
337
338 =back
339
340 =head1 Platform Support
341
342 XXX Any changes to platform support should be listed in the sections below.
343
344 [ Within the sections, list each platform as an =item entry with specific
345 changes as paragraphs below it. ]
346
347 =head2 New Platforms
348
349 XXX List any platforms that this version of perl compiles on, that previous
350 versions did not.  These will either be enabled by new files in the F<hints/>
351 directories, or new subdirectories and F<README> files at the top level of the
352 source tree.
353
354 =over 4
355
356 =item XXX-some-platform
357
358 XXX
359
360 =back
361
362 =head2 Discontinued Platforms
363
364 XXX List any platforms that this version of perl no longer compiles on.
365
366 =over 4
367
368 =item XXX-some-platform
369
370 XXX
371
372 =back
373
374 =head2 Platform-Specific Notes
375
376 XXX List any changes for specific platforms.  This could include configuration
377 and compilation changes or changes in portability/compatibility.  However,
378 changes within modules for platforms should generally be listed in the
379 L</Modules and Pragmata> section.
380
381 =over 4
382
383 =item XXX-some-platform
384
385 XXX
386
387 =back
388
389 =head1 Internal Changes
390
391 XXX Changes which affect the interface available to C<XS> code go here.  Other
392 significant internal changes for future core maintainers should be noted as
393 well.
394
395 [ List each change as an =item entry ]
396
397 =over 4
398
399 =item *
400
401 Added the C<<PL_curstackinfo->si_cxsubix>> field. This records the stack
402 index of the most recently pushed sub/format/eval context.  It is set and
403 restored automatically by C<cx_pushsub()>, C<cx_popsub()> etc., but would
404 need to be manually managed if you do any unusual manipulation of the
405 context stack.
406
407 =item *
408
409 Various macros dealing with character type classification and changing
410 case where the input is encoded in UTF-8 now require an extra parameter
411 to prevent potential reads beyond the end of the buffer.  Use of these
412 has generated a deprecation warning since 5.26.  Details are in
413 L<perldeprecation/In XS code, use of various macros dealing with UTF-8.>
414
415 =back
416
417 =head1 Selected Bug Fixes
418
419 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
420 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
421
422 [ List each fix as an =item entry ]
423
424 =over 4
425
426 =item *
427
428 XXX
429
430 =back
431
432 =head1 Known Problems
433
434 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
435 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
436 platform specific bugs also go here.
437
438 [ List each fix as an =item entry ]
439
440 =over 4
441
442 =item *
443
444 XXX
445
446 =back
447
448 =head1 Errata From Previous Releases
449
450 =over 4
451
452 =item *
453
454 XXX Add anything here that we forgot to add, or were mistaken about, in
455 the perldelta of a previous release.
456
457 =back
458
459 =head1 Obituary
460
461 XXX If any significant core contributor or member of the CPAN community has
462 died, add a short obituary here.
463
464 =head1 Acknowledgements
465
466 XXX Generate this with:
467
468   perl Porting/acknowledgements.pl v5.31.4..HEAD
469
470 =head1 Reporting Bugs
471
472 If you find what you think is a bug, you might check the perl bug database
473 at L<https://rt.perl.org/>.  There may also be information at
474 L<https://www.perl.org/>, the Perl Home Page.
475
476 If you believe you have an unreported bug, please run the L<perlbug> program
477 included with your release.  Be sure to trim your bug down to a tiny but
478 sufficient test case.  Your bug report, along with the output of C<perl -V>,
479 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
480
481 If the bug you are reporting has security implications which make it
482 inappropriate to send to a publicly archived mailing list, then see
483 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
484 for details of how to report the issue.
485
486 =head1 Give Thanks
487
488 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
489 you can do so by running the C<perlthanks> program:
490
491     perlthanks
492
493 This will send an email to the Perl 5 Porters list with your show of thanks.
494
495 =head1 SEE ALSO
496
497 The F<Changes> file for an explanation of how to view exhaustive details on
498 what changed.
499
500 The F<INSTALL> file for how to build Perl.
501
502 The F<README> file for general stuff.
503
504 The F<Artistic> and F<Copying> files for copyright information.
505
506 =cut