This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
2c65e94d6c2360b9beeeed7d6497fd99e8b2e90d
[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.4
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.31.3 release and the 5.31.4
13 release.
14
15 If you are upgrading from an earlier release such as 5.31.2, first read
16 L<perl5313delta>, which describes differences between 5.31.2 and 5.31.3.
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 =head2 Now can dump compiled patterns before optimization
31
32 This is primarily useful for tracking down bugs in the regular
33 expression compiler.  This dump happens on C<-DDEBUGGING> perls, if you
34 specify C<-Drv> on the command line; or on any perl if the pattern is
35 compiled within the scope of S<C<use re qw(Debug DUMP_PRE_OPTIMIZE)>> or
36 S<C<use re qw(Debug COMPILE EXTRA)>>.  (All but the 2nd case display
37 other information as well.)
38
39 =head1 Security
40
41 XXX Any security-related notices go here.  In particular, any security
42 vulnerabilities closed should be noted here rather than in the
43 L</Selected Bug Fixes> section.
44
45 [ List each security issue as a =head2 entry ]
46
47 =head1 Incompatible Changes
48
49 XXX For a release on a stable branch, this section aspires to be:
50
51     There are no changes intentionally incompatible with 5.XXX.XXX
52     If any exist, they are bugs, and we request that you submit a
53     report.  See L</Reporting Bugs> below.
54
55 [ List each incompatible change as a =head2 entry ]
56
57 =head1 Deprecations
58
59 XXX Any deprecated features, syntax, modules etc. should be listed here.
60
61 =head2 Module removals
62
63 XXX Remove this section if not applicable.
64
65 The following modules will be removed from the core distribution in a
66 future release, and will at that time need to be installed from CPAN.
67 Distributions on CPAN which require these modules will need to list them as
68 prerequisites.
69
70 The core versions of these modules will now issue C<"deprecated">-category
71 warnings to alert you to this fact.  To silence these deprecation warnings,
72 install the modules in question from CPAN.
73
74 Note that these are (with rare exceptions) fine modules that you are encouraged
75 to continue to use.  Their disinclusion from core primarily hinges on their
76 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
77 not usually on concerns over their design.
78
79 =over
80
81 =item XXX
82
83 XXX Note that deprecated modules should be listed here even if they are listed
84 as an updated module in the L</Modules and Pragmata> section.
85
86 =back
87
88 [ List each other deprecation as a =head2 entry ]
89
90 =head1 Performance Enhancements
91
92 XXX Changes which enhance performance without changing behaviour go here.
93 There may well be none in a stable release.
94
95 [ List each enhancement as an =item entry ]
96
97 =over 4
98
99 =item *
100
101 XXX
102
103 =back
104
105 =head1 Modules and Pragmata
106
107 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
108 go here.  If Module::CoreList is updated, generate an initial draft of the
109 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
110 for important changes should then be added by hand.  In an ideal world,
111 dual-life modules would have a F<Changes> file that could be cribbed.
112
113 The list of new and updated modules is modified automatically as part of
114 preparing a Perl release, so the only reason to manually add entries here is if
115 you're summarising the important changes in the module update. (Also, if the
116 manually-added details don't match the automatically-generated ones, the
117 release manager will have to investigate the situation carefully.)
118
119 [ Within each section, list entries as an =item entry ]
120
121 =head2 New Modules and Pragmata
122
123 =over 4
124
125 =item *
126
127 XXX Remove this section if not applicable.
128
129 =back
130
131 =head2 Updated Modules and Pragmata
132
133 =over 4
134
135 =item *
136
137 L<Test::Simple> has been upgraded from version 1.302166 to 1.302168.
138
139 =item *
140
141 L<XXX> has been upgraded from version A.xx to B.yy.
142
143 If there was something important to note about this change, include that here.
144
145 =back
146
147 =head2 Removed Modules and Pragmata
148
149 =over 4
150
151 =item *
152
153 XXX
154
155 =back
156
157 =head1 Documentation
158
159 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
160 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
161
162 =head2 New Documentation
163
164 XXX Changes which create B<new> files in F<pod/> go here.
165
166 =head3 L<XXX>
167
168 XXX Description of the purpose of the new file here
169
170 =head2 Changes to Existing Documentation
171
172 We have attempted to update the documentation to reflect the changes
173 listed in this document.  If you find any we have missed, send email
174 to L<perlbug@perl.org|mailto:perlbug@perl.org>.
175
176 XXX Changes which significantly change existing files in F<pod/> go here.
177 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
178 section.
179
180 Additionally, the following selected changes have been made:
181
182 =head3 L<XXX>
183
184 =over 4
185
186 =item *
187
188 XXX Description of the change here
189
190 =back
191
192 =head1 Diagnostics
193
194 The following additions or changes have been made to diagnostic output,
195 including warnings and fatal error messages.  For the complete list of
196 diagnostic messages, see L<perldiag>.
197
198 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
199 include any changes in L<perldiag> that reconcile it to the C<C> code.
200
201 =head2 New Diagnostics
202
203 XXX Newly added diagnostic messages go under here, separated into New Errors
204 and New Warnings
205
206 =head3 New Errors
207
208 =over 4
209
210 =item *
211
212 XXX L<message|perldiag/"message">
213
214 =back
215
216 =head3 New Warnings
217
218 =over 4
219
220 =item *
221
222 XXX L<message|perldiag/"message">
223
224 =back
225
226 =head2 Changes to Existing Diagnostics
227
228 XXX Changes (i.e. rewording) of diagnostic messages go here
229
230 =over 4
231
232 =item *
233
234 XXX Describe change here
235
236 =back
237
238 =head1 Utility Changes
239
240 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
241 Most of these are built within the directory F<utils>.
242
243 [ List utility changes as a =head2 entry for each utility and =item
244 entries for each change
245 Use L<XXX> with program names to get proper documentation linking. ]
246
247 =head2 L<XXX>
248
249 =over 4
250
251 =item *
252
253 XXX
254
255 =back
256
257 =head1 Configuration and Compilation
258
259 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
260 go here.  Any other changes to the Perl build process should be listed here.
261 However, any platform-specific changes should be listed in the
262 L</Platform Support> section, instead.
263
264 [ List changes as an =item entry ].
265
266 =over 4
267
268 =item *
269
270 XXX
271
272 =back
273
274 =head1 Testing
275
276 XXX Any significant changes to the testing of a freshly built perl should be
277 listed here.  Changes which create B<new> files in F<t/> go here as do any
278 large changes to the testing harness (e.g. when parallel testing was added).
279 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
280 that they represent may be covered elsewhere.
281
282 XXX If there were no significant test changes, say this:
283
284 Tests were added and changed to reflect the other additions and changes
285 in this release.
286
287 XXX If instead there were significant changes, say this:
288
289 Tests were added and changed to reflect the other additions and
290 changes in this release.  Furthermore, these significant changes were
291 made:
292
293 [ List each test improvement as an =item entry ]
294
295 =over 4
296
297 =item *
298
299 XXX
300
301 =back
302
303 =head1 Platform Support
304
305 XXX Any changes to platform support should be listed in the sections below.
306
307 [ Within the sections, list each platform as an =item entry with specific
308 changes as paragraphs below it. ]
309
310 =head2 New Platforms
311
312 XXX List any platforms that this version of perl compiles on, that previous
313 versions did not.  These will either be enabled by new files in the F<hints/>
314 directories, or new subdirectories and F<README> files at the top level of the
315 source tree.
316
317 =over 4
318
319 =item XXX-some-platform
320
321 XXX
322
323 =back
324
325 =head2 Discontinued Platforms
326
327 XXX List any platforms that this version of perl no longer compiles on.
328
329 =over 4
330
331 =item XXX-some-platform
332
333 XXX
334
335 =back
336
337 =head2 Platform-Specific Notes
338
339 XXX List any changes for specific platforms.  This could include configuration
340 and compilation changes or changes in portability/compatibility.  However,
341 changes within modules for platforms should generally be listed in the
342 L</Modules and Pragmata> section.
343
344 =over 4
345
346 =item Win32
347
348 The locale tests could crash on Win32 due to a Windows bug, and
349 separately due to the CRT throwing an exception if the locale name
350 wasn't validly encoded in the current code page.
351
352 For the second we now decode the locale name ourselves, and always
353 decode it as UTF-8.  [perl #133981]
354
355 =back
356
357 =head1 Internal Changes
358
359 XXX Changes which affect the interface available to C<XS> code go here.  Other
360 significant internal changes for future core maintainers should be noted as
361 well.
362
363 [ List each change as an =item entry ]
364
365 =over 4
366
367 =item *
368
369 XXX
370
371 =back
372
373 =head1 Selected Bug Fixes
374
375 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
376 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
377
378 [ List each fix as an =item entry ]
379
380 =over 4
381
382 =item *
383
384 Perl no longer treats strings starting with "0x" or "0b" as hex or
385 binary numbers respectively when converting a string to a number.
386 This reverts a change in behaviour inadvertently introduced in perl
387 5.30.0 intended to improve precision when converting a string to a
388 floating point number. [perl #134230]
389
390 =item *
391
392 Matching a non-C<SVf_UTF8> string against a regular expression
393 containing unicode literals could leak a SV on each match attempt.
394 [perl #134390]
395
396 =back
397
398 =head1 Known Problems
399
400 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
401 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
402 platform specific bugs also go here.
403
404 [ List each fix as an =item entry ]
405
406 =over 4
407
408 =item *
409
410 XXX
411
412 =back
413
414 =head1 Errata From Previous Releases
415
416 =over 4
417
418 =item *
419
420 XXX Add anything here that we forgot to add, or were mistaken about, in
421 the perldelta of a previous release.
422
423 =back
424
425 =head1 Obituary
426
427 XXX If any significant core contributor or member of the CPAN community has
428 died, add a short obituary here.
429
430 =head1 Acknowledgements
431
432 XXX Generate this with:
433
434   perl Porting/acknowledgements.pl v5.31.3..HEAD
435
436 =head1 Reporting Bugs
437
438 If you find what you think is a bug, you might check the perl bug database
439 at L<https://rt.perl.org/>.  There may also be information at
440 L<http://www.perl.org/>, the Perl Home Page.
441
442 If you believe you have an unreported bug, please run the L<perlbug> program
443 included with your release.  Be sure to trim your bug down to a tiny but
444 sufficient test case.  Your bug report, along with the output of C<perl -V>,
445 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
446
447 If the bug you are reporting has security implications which make it
448 inappropriate to send to a publicly archived mailing list, then see
449 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
450 for details of how to report the issue.
451
452 =head1 Give Thanks
453
454 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
455 you can do so by running the C<perlthanks> program:
456
457     perlthanks
458
459 This will send an email to the Perl 5 Porters list with your show of thanks.
460
461 =head1 SEE ALSO
462
463 The F<Changes> file for an explanation of how to view exhaustive details on
464 what changed.
465
466 The F<INSTALL> file for how to build Perl.
467
468 The F<README> file for general stuff.
469
470 The F<Artistic> and F<Copying> files for copyright information.
471
472 =cut