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