This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update Test-Simple to CPAN version 1.302166
[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.3
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.31.2 release and the 5.31.3
13 release.
14
15 If you are upgrading from an earlier release such as 5.31.1, first read
16 L<perl5312delta>, which describes differences between 5.31.1 and 5.31.2.
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 Plain "0" string now treated as a number for range operator
49
50 Previously a range C< "0" .. "-1" > would produce a range of numeric
51 strings from "0" through "99", this now produces an empty list, just
52 as C< 0 .. -1 > does.
53
54 This was due to a special case that treated strings starting with "0"
55 as strings so ranges like C< "00" .. "03" > produced C< "00", "01",
56 "02", "03" >, but didn't specially handle the string C<"0">.
57
58 [perl #133695]
59
60 =head2 C<\K> now disallowed in look-ahead and look-behind assertions
61
62 This was disallowed because it causes unexpected behaviour, and no-one
63 could define what the desired behaviour was.
64
65 [perl #124256]
66
67 =head1 Deprecations
68
69 XXX Any deprecated features, syntax, modules etc. should be listed here.
70
71 =head2 Module removals
72
73 XXX Remove this section if not applicable.
74
75 The following modules will be removed from the core distribution in a
76 future release, and will at that time need to be installed from CPAN.
77 Distributions on CPAN which require these modules will need to list them as
78 prerequisites.
79
80 The core versions of these modules will now issue C<"deprecated">-category
81 warnings to alert you to this fact.  To silence these deprecation warnings,
82 install the modules in question from CPAN.
83
84 Note that these are (with rare exceptions) fine modules that you are encouraged
85 to continue to use.  Their disinclusion from core primarily hinges on their
86 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
87 not usually on concerns over their design.
88
89 =over
90
91 =item XXX
92
93 XXX Note that deprecated modules should be listed here even if they are listed
94 as an updated module in the L</Modules and Pragmata> section.
95
96 =back
97
98 [ List each other deprecation as a =head2 entry ]
99
100 =head1 Performance Enhancements
101
102 XXX Changes which enhance performance without changing behaviour go here.
103 There may well be none in a stable release.
104
105 [ List each enhancement as an =item entry ]
106
107 =over 4
108
109 =item *
110
111 XXX
112
113 =back
114
115 =head1 Modules and Pragmata
116
117 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
118 go here.  If Module::CoreList is updated, generate an initial draft of the
119 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
120 for important changes should then be added by hand.  In an ideal world,
121 dual-life modules would have a F<Changes> file that could be cribbed.
122
123 The list of new and updated modules is modified automatically as part of
124 preparing a Perl release, so the only reason to manually add entries here is if
125 you're summarising the important changes in the module update. (Also, if the
126 manually-added details don't match the automatically-generated ones, the
127 release manager will have to investigate the situation carefully.)
128
129 [ Within each section, list entries as an =item entry ]
130
131 =head2 New Modules and Pragmata
132
133 =over 4
134
135 =item *
136
137 XXX Remove this section if not applicable.
138
139 =back
140
141 =head2 Updated Modules and Pragmata
142
143 =over 4
144
145 =item *
146
147 L<Devel::PPPort> has been upgraded from version 3.54 to 3.55.
148
149 The test files generated on Win32 are now identical to when they are
150 generated on POSIX-like systems.
151
152 =item *
153
154 L<File::Find> has been upgraded from version 1.36 to 1.37.
155
156 On Win32, the tests no longer require either a file in the drive root
157 directory, or a writable root directory.
158
159 =item *
160
161 L<Thread> has been upgraded from version 3.04 to 3.05.
162
163 =item *
164
165 L<Getopt::Long> has been upgraded from version 2.50 to 2.51.
166
167 =item *
168
169 L<Time::HiRes> has been upgraded from version 1.9761 to 1.9762.
170
171 Removed obsolete code such as support for pre-5.6 perl and classic
172 MacOS.  [perl #134288]
173
174 =item *
175
176 L<I18N::LangTags> has been upgraded from version 1.07 to 1.08.
177
178 Document the C<IGNORE_WIN32_LOCALE> environment variable.
179
180 =item *
181
182 L<XXX> has been upgraded from version A.xx to B.yy.
183
184 If there was something important to note about this change, include that here.
185
186 =back
187
188 =head2 Removed Modules and Pragmata
189
190 =over 4
191
192 =item *
193
194 XXX
195
196 =back
197
198 =head1 Documentation
199
200 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
201 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
202
203 =head2 New Documentation
204
205 XXX Changes which create B<new> files in F<pod/> go here.
206
207 =head3 L<XXX>
208
209 XXX Description of the purpose of the new file here
210
211 =head2 Changes to Existing Documentation
212
213 We have attempted to update the documentation to reflect the changes
214 listed in this document.  If you find any we have missed, send email
215 to L<perlbug@perl.org|mailto:perlbug@perl.org>.
216
217 XXX Changes which significantly change existing files in F<pod/> go here.
218 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
219 section.
220
221 Additionally, the following selected changes have been made:
222
223 =head3 L<XXX>
224
225 =over 4
226
227 =item *
228
229 XXX Description of the change here
230
231 =back
232
233 =head1 Diagnostics
234
235 The following additions or changes have been made to diagnostic output,
236 including warnings and fatal error messages.  For the complete list of
237 diagnostic messages, see L<perldiag>.
238
239 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
240 include any changes in L<perldiag> that reconcile it to the C<C> code.
241
242 =head2 New Diagnostics
243
244 XXX Newly added diagnostic messages go under here, separated into New Errors
245 and New Warnings
246
247 =head3 New Errors
248
249 =over 4
250
251 =item *
252
253 XXX L<message|perldiag/"message">
254
255 =back
256
257 =head3 New Warnings
258
259 =over 4
260
261 =item *
262
263 XXX L<message|perldiag/"message">
264
265 =back
266
267 =head2 Changes to Existing Diagnostics
268
269 XXX Changes (i.e. rewording) of diagnostic messages go here
270
271 =over 4
272
273 =item *
274
275 XXX Describe change here
276
277 =back
278
279 =head1 Utility Changes
280
281 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
282 Most of these are built within the directory F<utils>.
283
284 [ List utility changes as a =head2 entry for each utility and =item
285 entries for each change
286 Use L<XXX> with program names to get proper documentation linking. ]
287
288 =head2 L<XXX>
289
290 =over 4
291
292 =item *
293
294 XXX
295
296 =back
297
298 =head1 Configuration and Compilation
299
300 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
301 go here.  Any other changes to the Perl build process should be listed here.
302 However, any platform-specific changes should be listed in the
303 L</Platform Support> section, instead.
304
305 [ List changes as an =item entry ].
306
307 =over 4
308
309 =item *
310
311 XXX
312
313 =back
314
315 =head1 Testing
316
317 XXX Any significant changes to the testing of a freshly built perl should be
318 listed here.  Changes which create B<new> files in F<t/> go here as do any
319 large changes to the testing harness (e.g. when parallel testing was added).
320 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
321 that they represent may be covered elsewhere.
322
323 XXX If there were no significant test changes, say this:
324
325 Tests were added and changed to reflect the other additions and changes
326 in this release.
327
328 XXX If instead there were significant changes, say this:
329
330 Tests were added and changed to reflect the other additions and
331 changes in this release.  Furthermore, these significant changes were
332 made:
333
334 [ List each test improvement as an =item entry ]
335
336 =over 4
337
338 =item *
339
340 XXX
341
342 =back
343
344 =head1 Platform Support
345
346 XXX Any changes to platform support should be listed in the sections below.
347
348 [ Within the sections, list each platform as an =item entry with specific
349 changes as paragraphs below it. ]
350
351 =head2 New Platforms
352
353 XXX List any platforms that this version of perl compiles on, that previous
354 versions did not.  These will either be enabled by new files in the F<hints/>
355 directories, or new subdirectories and F<README> files at the top level of the
356 source tree.
357
358 =over 4
359
360 =item XXX-some-platform
361
362 XXX
363
364 =back
365
366 =head2 Discontinued Platforms
367
368 XXX List any platforms that this version of perl no longer compiles on.
369
370 =over 4
371
372 =item XXX-some-platform
373
374 XXX
375
376 =back
377
378 =head2 Platform-Specific Notes
379
380 XXX List any changes for specific platforms.  This could include configuration
381 and compilation changes or changes in portability/compatibility.  However,
382 changes within modules for platforms should generally be listed in the
383 L</Modules and Pragmata> section.
384
385 =over 4
386
387 =item Windows
388
389 F<t/op/magic.t> could fail if environment varables starting with
390 C<FOO> already existed.
391
392 =back
393
394 =head1 Internal Changes
395
396 XXX Changes which affect the interface available to C<XS> code go here.  Other
397 significant internal changes for future core maintainers should be noted as
398 well.
399
400 [ List each change as an =item entry ]
401
402 =over 4
403
404 =item *
405
406 A new parser function L<parse_subsignature()|perlapi/parse_subsignature>
407 allows a keyword plugin to parse a subroutine signature while C<use feature
408 'signatures'> is in effect.  This allows custom keywords to implement
409 semantics similar to regular C<sub> declarations that include signatures.
410 [perl #132474]
411
412 =item *
413
414 Since on some platforms we need to hold a mutex when temporarily
415 switching locales, new macros (C<STORE_LC_NUMERIC_SET_TO_NEEDED_IN>,
416 C<WITH_LC_NUMERIC_SET_TO_NEEDED> and C<WITH_LC_NUMERIC_SET_TO_NEEDED_IN>)
417 have been added to make it easier to do this safely and efficiently
418 as part of [perl #134172].
419
420 =back
421
422 =head1 Selected Bug Fixes
423
424 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
425 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
426
427 [ List each fix as an =item entry ]
428
429 =over 4
430
431 =item *
432
433 C<< $@ = 100; die; >> now correctly propagates the 100 as an exception
434 instead of ignoring it.  [perl #134291]
435
436 =item *
437
438 C<< 0 0x@ >> no longer asserts in S_no_op().  [perl #134310]
439
440 =item *
441
442 Exceptions thrown while C<$@> is read-only could result in infinite
443 recursion as perl tried to update C<$@>, which throws another
444 exception, resulting in a stack overflow.  Perl now replaces C<$@>
445 with a copy if it's not a simple writable SV.  [perl #134266]
446
447 =back
448
449 =head1 Known Problems
450
451 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
452 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
453 platform specific bugs also go here.
454
455 [ List each fix as an =item entry ]
456
457 =over 4
458
459 =item *
460
461 XXX
462
463 =back
464
465 =head1 Errata From Previous Releases
466
467 =over 4
468
469 =item *
470
471 XXX Add anything here that we forgot to add, or were mistaken about, in
472 the perldelta of a previous release.
473
474 =back
475
476 =head1 Obituary
477
478 XXX If any significant core contributor or member of the CPAN community has
479 died, add a short obituary here.
480
481 =head1 Acknowledgements
482
483 XXX Generate this with:
484
485   perl Porting/acknowledgements.pl v5.31.2..HEAD
486
487 =head1 Reporting Bugs
488
489 If you find what you think is a bug, you might check the perl bug database
490 at L<https://rt.perl.org/>.  There may also be information at
491 L<http://www.perl.org/>, the Perl Home Page.
492
493 If you believe you have an unreported bug, please run the L<perlbug> program
494 included with your release.  Be sure to trim your bug down to a tiny but
495 sufficient test case.  Your bug report, along with the output of C<perl -V>,
496 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
497
498 If the bug you are reporting has security implications which make it
499 inappropriate to send to a publicly archived mailing list, then see
500 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
501 for details of how to report the issue.
502
503 =head1 Give Thanks
504
505 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
506 you can do so by running the C<perlthanks> program:
507
508     perlthanks
509
510 This will send an email to the Perl 5 Porters list with your show of thanks.
511
512 =head1 SEE ALSO
513
514 The F<Changes> file for an explanation of how to view exhaustive details on
515 what changed.
516
517 The F<INSTALL> file for how to build Perl.
518
519 The F<README> file for general stuff.
520
521 The F<Artistic> and F<Copying> files for copyright information.
522
523 =cut