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