This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
56f0be1f245d88f52a694755492aeb3d9b760540
[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.2
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.31.1 release and the 5.31.2
13 release.
14
15 If you are upgrading from an earlier release such as 5.31.0, first read
16 L<perl5311delta>, which describes differences between 5.31.0 and 5.31.1.
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 not applicable.
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 an =item entry ]
87
88 =over 4
89
90 =item *
91
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
115
116 =item *
117
118 XXX Remove this section if not applicable.
119
120 =back
121
122 =head2 Updated Modules and Pragmata
123
124 =over 4
125
126 =item *
127
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
137
138 =item *
139
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 We have attempted to update the documentation to reflect the changes
160 listed in this document.  If you find any we have missed, send email
161 to L<perlbug@perl.org|mailto:perlbug@perl.org>.
162
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>
170
171 =over 4
172
173 =item *
174
175 XXX Description of the change here
176
177 =back
178
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
194
195 =over 4
196
197 =item *
198
199 XXX L<message|perldiag/"message">
200
201 =back
202
203 =head3 New Warnings
204
205 =over 4
206
207 =item *
208
209 XXX L<message|perldiag/"message">
210
211 =back
212
213 =head2 Changes to Existing Diagnostics
214
215 XXX Changes (i.e. rewording) of diagnostic messages go here
216
217 =over 4
218
219 =item *
220
221 C<\N{} here is restricted to one character> is now emitted in the same
222 circumstances where previously C<\N{} in inverted character class or as
223 a range end-point is restricted to one character> was.
224
225 This is due to new circumstances having been added in perl v5.30 that
226 weren't covered by the earlier wording.
227
228 =back
229
230 =head1 Utility Changes
231
232 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
233 Most of these are built within the directory F<utils>.
234
235 [ List utility changes as a =head2 entry for each utility and =item
236 entries for each change
237 Use L<XXX> with program names to get proper documentation linking. ]
238
239 =head2 L<XXX>
240
241 =over 4
242
243 =item *
244
245 XXX
246
247 =back
248
249 =head1 Configuration and Compilation
250
251 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
252 go here.  Any other changes to the Perl build process should be listed here.
253 However, any platform-specific changes should be listed in the
254 L</Platform Support> section, instead.
255
256 [ List changes as an =item entry ].
257
258 =over 4
259
260 =item *
261
262 The C<ECHO> macro is now defined.  This is used in a C<dtrace> rule
263 that was originally changed for FreeBSD, and the FreeBSD make
264 apparently predefines it.  The Solaris make does not predefine C<ECHO>
265 which broke this rule on Solaris.  [perl #134218]
266
267 =back
268
269 =head1 Testing
270
271 XXX Any significant changes to the testing of a freshly built perl should be
272 listed here.  Changes which create B<new> files in F<t/> go here as do any
273 large changes to the testing harness (e.g. when parallel testing was added).
274 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
275 that they represent may be covered elsewhere.
276
277 XXX If there were no significant test changes, say this:
278
279 Tests were added and changed to reflect the other additions and changes
280 in this release.
281
282 XXX If instead there were significant changes, say this:
283
284 Tests were added and changed to reflect the other additions and
285 changes in this release.  Furthermore, these significant changes were
286 made:
287
288 [ List each test improvement as an =item entry ]
289
290 =over 4
291
292 =item *
293
294 XXX
295
296 =back
297
298 =head1 Platform Support
299
300 XXX Any changes to platform support should be listed in the sections below.
301
302 [ Within the sections, list each platform as an =item entry with specific
303 changes as paragraphs below it. ]
304
305 =head2 New Platforms
306
307 XXX List any platforms that this version of perl compiles on, that previous
308 versions did not.  These will either be enabled by new files in the F<hints/>
309 directories, or new subdirectories and F<README> files at the top level of the
310 source tree.
311
312 =over 4
313
314 =item XXX-some-platform
315
316 XXX
317
318 =back
319
320 =head2 Discontinued Platforms
321
322 XXX List any platforms that this version of perl no longer compiles on.
323
324 =over 4
325
326 =item XXX-some-platform
327
328 XXX
329
330 =back
331
332 =head2 Platform-Specific Notes
333
334 XXX List any changes for specific platforms.  This could include configuration
335 and compilation changes or changes in portability/compatibility.  However,
336 changes within modules for platforms should generally be listed in the
337 L</Modules and Pragmata> section.
338
339 =over 4
340
341 =item Linux
342
343 C<cc> will be used to populate C<plibpth> if C<cc> is C<clang>.  [perl
344 #134189]
345
346 =item VMS
347
348 C<-Duse64bitint> is now the default on VMS.
349
350 =back
351
352 =head1 Internal Changes
353
354 XXX Changes which affect the interface available to C<XS> code go here.  Other
355 significant internal changes for future core maintainers should be noted as
356 well.
357
358 [ List each change as an =item entry ]
359
360 =over 4
361
362 =item *
363
364 The PERL_DESTRUCT_LEVEL environment variable was formerly only honored on
365 perl binaries built with DEBUGGING support. It it now checked on all perl
366 builds. Its normal use is to force perl to individually free every block
367 of memory which it has allocated before exiting, which is useful when
368 using automated leak detection tools such as valgrind.
369
370 =back
371
372 =head1 Selected Bug Fixes
373
374 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
375 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
376
377 [ List each fix as an =item entry ]
378
379 =over 4
380
381 =item *
382
383 Parsing incomplete hex or binary literals was changed in 5.31.1 to
384 treat such a literal as just the 0, leaving the following C<x> or C<b>
385 to be parsed as part of the next token.  This could lead to some
386 silent changes in behaviour, so now incomplete hex or binary literals
387 produce a fatal error.  [perl #134125]
388
389 =back
390
391 =head1 Known Problems
392
393 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
394 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
395 platform specific bugs also go here.
396
397 [ List each fix as an =item entry ]
398
399 =over 4
400
401 =item *
402
403 XXX
404
405 =back
406
407 =head1 Errata From Previous Releases
408
409 =over 4
410
411 =item *
412
413 XXX Add anything here that we forgot to add, or were mistaken about, in
414 the perldelta of a previous release.
415
416 =back
417
418 =head1 Obituary
419
420 XXX If any significant core contributor or member of the CPAN community has
421 died, add a short obituary here.
422
423 =head1 Acknowledgements
424
425 XXX Generate this with:
426
427   perl Porting/acknowledgements.pl v5.31.1..HEAD
428
429 =head1 Reporting Bugs
430
431 If you find what you think is a bug, you might check the perl bug database
432 at L<https://rt.perl.org/>.  There may also be information at
433 L<http://www.perl.org/>, the Perl Home Page.
434
435 If you believe you have an unreported bug, please run the L<perlbug> program
436 included with your release.  Be sure to trim your bug down to a tiny but
437 sufficient test case.  Your bug report, along with the output of C<perl -V>,
438 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
439
440 If the bug you are reporting has security implications which make it
441 inappropriate to send to a publicly archived mailing list, then see
442 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
443 for details of how to report the issue.
444
445 =head1 Give Thanks
446
447 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
448 you can do so by running the C<perlthanks> program:
449
450     perlthanks
451
452 This will send an email to the Perl 5 Porters list with your show of thanks.
453
454 =head1 SEE ALSO
455
456 The F<Changes> file for an explanation of how to view exhaustive details on
457 what changed.
458
459 The F<INSTALL> file for how to build Perl.
460
461 The F<README> file for general stuff.
462
463 The F<Artistic> and F<Copying> files for copyright information.
464
465 =cut