This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
(toke|regcomp).c: Use common fcn to handle \0 problems
[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.9
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.31.8 release and the 5.31.9
13 release.
14
15 If you are upgrading from an earlier release such as 5.31.7, first read
16 L<perl5318delta>, which describes differences between 5.31.7 and 5.31.8.
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, open an issue
161 at L<https://github.com/Perl/perl5/issues>.
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 Links to the now defunct L<https://search.cpan.org> site now point at
176 the equivalent L<https://metacpan.org> URL.  [GH #17393]
177
178 =back
179
180 =head1 Diagnostics
181
182 The following additions or changes have been made to diagnostic output,
183 including warnings and fatal error messages.  For the complete list of
184 diagnostic messages, see L<perldiag>.
185
186 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
187 include any changes in L<perldiag> that reconcile it to the C<C> code.
188
189 =head2 New Diagnostics
190
191 XXX Newly added diagnostic messages go under here, separated into New Errors
192 and New Warnings
193
194 =head3 New Errors
195
196 =over 4
197
198 =item *
199
200 XXX L<message|perldiag/"message">
201
202 =back
203
204 =head3 New Warnings
205
206 =over 4
207
208 =item *
209
210 L<Code point 0x%X is not Unicode, and not portable|perldiag/"Code point 0x%X is not Unicode, and not portable">
211
212 This is actually not a new message, but it is now output when the
213 warnings category C<portable> is enabled.
214
215 When raised during regular expression pattern compilation, the warning
216 has extra text added at the end marking where precisely in the pattern
217 it occured.
218
219 =item *
220
221 L<Non-hex character '%c' terminates \x early.  Resolved as "%s"|perldiag/"Non-hex character '%c' terminates \x early.  Resolved as "%s"">
222
223 This replaces a warning that was much less specific, and which gave
224 false information.  This new warning parallels the similar
225 already-existing one raised for C<\o{}>.
226
227 =item *
228
229 L<message|perldiag/"message">
230
231 =back
232
233 =head2 Changes to Existing Diagnostics
234
235 XXX Changes (i.e. rewording) of diagnostic messages go here
236
237 =over 4
238
239 =item *
240
241 L<Character following "\c" must be printable ASCII|perldiag/"Character following "\c" must be printable ASCII">
242
243 now has extra text added at the end, when raised during regular
244 expression pattern compilation, marking where precisely in the pattern
245 it occured.
246
247 =item *
248
249 L<Use "%s" instead of "%s"|perldiag/"Use "%s" instead of "%s"">
250
251 now has extra text added at the end, when raised during regular
252 expression pattern compilation, marking where precisely in the pattern
253 it occured.
254
255 =item *
256
257 L<Sequence "\c{" invalid|perldiag/"Sequence "\c{" invalid">
258
259 now has extra text added at the end, when raised during regular
260 expression pattern compilation, marking where precisely in the pattern
261 it occured.
262
263 =item *
264
265 L<"\c%c" is more clearly written simply as "%s"|perldiag/""\c%c" is more clearly written simply as "%s"">
266
267 now has extra text added at the end, when raised during regular
268 expression pattern compilation, marking where precisely in the pattern
269 it occured.
270
271 =item *
272
273 L<Non-octal character '%c' terminates \o early.  Resolved as "%s"|perldiag/"Non-octal character '%c' terminates \o early.  Resolved as "%s"">
274
275 now includes the phrase "terminates \o early", and has extra text added
276 at the end, when raised during regular expression pattern compilation,
277 marking where precisely in the pattern it occured.  In some instances
278 the text of the resolution has been clarified.
279
280 =item *
281
282 L<'%s' resolved to '\o{%s}%d'|perldiag/'%s' resolved to '\o{%s}%d'>
283
284 As of Perl 5.32, this message is no longer generated.  Instead,
285 L<perldiag/Non-octal character '%c' terminates \o early.  Resolved as "%s">
286 is.
287
288 =back
289
290 =head1 Utility Changes
291
292 XXX Changes to installed programs such as F<perldoc> and F<xsubpp> go here.
293 Most of these are built within the directory F<utils>.
294
295 [ List utility changes as a =head2 entry for each utility and =item
296 entries for each change
297 Use L<XXX> with program names to get proper documentation linking. ]
298
299 =head2 L<XXX>
300
301 =over 4
302
303 =item *
304
305 XXX
306
307 =back
308
309 =head1 Configuration and Compilation
310
311 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
312 go here.  Any other changes to the Perl build process should be listed here.
313 However, any platform-specific changes should be listed in the
314 L</Platform Support> section, instead.
315
316 [ List changes as an =item entry ].
317
318 =over 4
319
320 =item *
321
322 XXX
323
324 =back
325
326 =head1 Testing
327
328 XXX Any significant changes to the testing of a freshly built perl should be
329 listed here.  Changes which create B<new> files in F<t/> go here as do any
330 large changes to the testing harness (e.g. when parallel testing was added).
331 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
332 that they represent may be covered elsewhere.
333
334 XXX If there were no significant test changes, say this:
335
336 Tests were added and changed to reflect the other additions and changes
337 in this release.
338
339 XXX If instead there were significant changes, say this:
340
341 Tests were added and changed to reflect the other additions and
342 changes in this release.  Furthermore, these significant changes were
343 made:
344
345 [ List each test improvement as an =item entry ]
346
347 =over 4
348
349 =item *
350
351 XXX
352
353 =back
354
355 =head1 Platform Support
356
357 XXX Any changes to platform support should be listed in the sections below.
358
359 [ Within the sections, list each platform as an =item entry with specific
360 changes as paragraphs below it. ]
361
362 =head2 New Platforms
363
364 XXX List any platforms that this version of perl compiles on, that previous
365 versions did not.  These will either be enabled by new files in the F<hints/>
366 directories, or new subdirectories and F<README> files at the top level of the
367 source tree.
368
369 =over 4
370
371 =item XXX-some-platform
372
373 XXX
374
375 =back
376
377 =head2 Discontinued Platforms
378
379 XXX List any platforms that this version of perl no longer compiles on.
380
381 =over 4
382
383 =item XXX-some-platform
384
385 XXX
386
387 =back
388
389 =head2 Platform-Specific Notes
390
391 XXX List any changes for specific platforms.  This could include configuration
392 and compilation changes or changes in portability/compatibility.  However,
393 changes within modules for platforms should generally be listed in the
394 L</Modules and Pragmata> section.
395
396 =over 4
397
398 =item VMS
399
400 With the release of the patch kit C99 V2.0, VSI has provided support for a
401 number of previously-missing C99 features.  On systems with that patch kit
402 installed, Perl's configuration process will now detect the presence of the
403 header C<stdint.h> and the following functions: C<fpclassify>, C<isblank>, C<isless>,
404 C<llrint>, C<llrintl>, C<llround>, C<llroundl>, C<nearbyint>, C<round>, C<scalbn>,
405 and C<scalbnl>.
406
407 =back
408
409 =head1 Internal Changes
410
411 XXX Changes which affect the interface available to C<XS> code go here.  Other
412 significant internal changes for future core maintainers should be noted as
413 well.
414
415 [ List each change as an =item entry ]
416
417 =over 4
418
419 =item *
420
421 XXX
422
423 =back
424
425 =head1 Selected Bug Fixes
426
427 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
428 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
429
430 [ List each fix as an =item entry ]
431
432 =over 4
433
434 =item *
435
436 XXX
437
438 =back
439
440 =head1 Known Problems
441
442 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
443 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
444 platform specific bugs also go here.
445
446 [ List each fix as an =item entry ]
447
448 =over 4
449
450 =item *
451
452 XXX
453
454 =back
455
456 =head1 Errata From Previous Releases
457
458 =over 4
459
460 =item *
461
462 XXX Add anything here that we forgot to add, or were mistaken about, in
463 the perldelta of a previous release.
464
465 =back
466
467 =head1 Obituary
468
469 XXX If any significant core contributor or member of the CPAN community has
470 died, add a short obituary here.
471
472 =head1 Acknowledgements
473
474 XXX Generate this with:
475
476   perl Porting/acknowledgements.pl v5.31.8..HEAD
477
478 =head1 Reporting Bugs
479
480 If you find what you think is a bug, you might check the perl bug database
481 at L<https://github.com/Perl/perl5/issues>.  There may also be information at
482 L<http://www.perl.org/>, the Perl Home Page.
483
484 If you believe you have an unreported bug, please open an issue at
485 L<https://github.com/Perl/perl5/issues>.  Be sure to trim your bug down to a
486 tiny but sufficient test case.
487
488 If the bug you are reporting has security implications which make it
489 inappropriate to send to a public issue tracker, then see
490 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
491 for details of how to report the issue.
492
493 =head1 Give Thanks
494
495 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
496 you can do so by running the C<perlthanks> program:
497
498     perlthanks
499
500 This will send an email to the Perl 5 Porters list with your show of thanks.
501
502 =head1 SEE ALSO
503
504 The F<Changes> file for an explanation of how to view exhaustive details on
505 what changed.
506
507 The F<INSTALL> file for how to build Perl.
508
509 The F<README> file for general stuff.
510
511 The F<Artistic> and F<Copying> files for copyright information.
512
513 =cut