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