This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for e8d55f27af46, ebcc725e3f7e
[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.6
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.27.5 release and the 5.27.6
13 release.
14
15 If you are upgrading from an earlier release such as 5.27.4, first read
16 L<perl5275delta>, which describes differences between 5.27.4 and 5.27.5.
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 inapplicable.
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
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 =back
131
132 =head2 Removed Modules and Pragmata
133
134 =over 4
135
136 =item *
137
138 XXX
139
140 =back
141
142 =head1 Documentation
143
144 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
145 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
146
147 =head2 New Documentation
148
149 XXX Changes which create B<new> files in F<pod/> go here.
150
151 =head3 L<XXX>
152
153 XXX Description of the purpose of the new file here
154
155 =head2 Changes to Existing Documentation
156
157 We have attempted to update the documentation to reflect the changes
158 listed in this document.  If you find any we have missed, send email
159 to L<perlbug@perl.org|mailto:perlbug@perl.org>.
160
161 XXX Changes which significantly change existing files in F<pod/> go here.
162 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
163 section.
164
165 Additionally, the following selected changes have been made:
166
167 =head3 L<perldiag/Variable length lookbehind not implemented in regex m/%s/>
168
169 This now gives more ideas as to workarounds to the issue that was
170 introduced in Perl 5.18 (but not documented explicitly in its perldelta)
171 for the fact that some Unicode C</i> rules cause a few sequences such as
172
173  (?<!st)
174
175 to be considered variable length, and hence disallowed.
176
177 =over 4
178
179 =item *
180
181 XXX Description of the change here
182
183 =back
184
185 =head1 Diagnostics
186
187 The following additions or changes have been made to diagnostic output,
188 including warnings and fatal error messages.  For the complete list of
189 diagnostic messages, see L<perldiag>.
190
191 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
192 include any changes in L<perldiag> that reconcile it to the C<C> code.
193
194 =head2 New Diagnostics
195
196 XXX Newly added diagnostic messages go under here, separated into New Errors
197 and New Warnings
198
199 =head3 New Errors
200
201 =over 4
202
203 =item *
204
205 XXX L<message|perldiag/"message">
206
207 =back
208
209 =head3 New Warnings
210
211 =over 4
212
213 =item *
214
215 XXX L<message|perldiag/"message">
216
217 =back
218
219 =head2 Changes to Existing Diagnostics
220
221 XXX Changes (i.e. rewording) of diagnostic messages go here
222
223 =over 4
224
225 =item *
226
227 XXX Describe change here
228
229 =back
230
231 =head1 Utility Changes
232
233 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
234 Most of these are built within the directory F<utils>.
235
236 [ List utility changes as a =head2 entry for each utility and =item
237 entries for each change
238 Use L<XXX> with program names to get proper documentation linking. ]
239
240 =head2 L<XXX>
241
242 =over 4
243
244 =item *
245
246 XXX
247
248 =back
249
250 =head1 Configuration and Compilation
251
252 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
253 go here.  Any other changes to the Perl build process should be listed here.
254 However, any platform-specific changes should be listed in the
255 L</Platform Support> section, instead.
256
257 [ List changes as an =item entry ].
258
259 =over 4
260
261 =item New probes
262
263 =over 2
264
265 =item HAS_BUILTIN_ADD_OVERFLOW
266
267 =item HAS_BUILTIN_MUL_OVERFLOW
268
269 =item HAS_BUILTIN_SUB_OVERFLOW
270
271 =item HAS_THREAD_SAFE_NL_LANGINFO_L
272
273 =item HAS_LOCALECONV_L
274
275 =item HAS_MBRLEN
276
277 =item HAS_MBRTOWC
278
279 =item HAS_MEMRCHR
280
281 =item HAS_NANOSLEEP
282
283 =item HAS_STRNLEN
284
285 =item HAS_STRTOLD_L
286
287 =item I_WCHAR
288
289 =back
290
291 =back
292
293 =head1 Testing
294
295 XXX Any significant changes to the testing of a freshly built perl should be
296 listed here.  Changes which create B<new> files in F<t/> go here as do any
297 large changes to the testing harness (e.g. when parallel testing was added).
298 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
299 that they represent may be covered elsewhere.
300
301 XXX If there were no significant test changes, say this:
302
303 Tests were added and changed to reflect the other additions and changes
304 in this release.
305
306 XXX If instead there were significant changes, say this:
307
308 Tests were added and changed to reflect the other additions and
309 changes in this release.  Furthermore, these significant changes were
310 made:
311
312 [ List each test improvement as an =item entry ]
313
314 =over 4
315
316 =item *
317
318 XXX
319
320 =back
321
322 =head1 Platform Support
323
324 XXX Any changes to platform support should be listed in the sections below.
325
326 [ Within the sections, list each platform as an =item entry with specific
327 changes as paragraphs below it. ]
328
329 =head2 New Platforms
330
331 XXX List any platforms that this version of perl compiles on, that previous
332 versions did not.  These will either be enabled by new files in the F<hints/>
333 directories, or new subdirectories and F<README> files at the top level of the
334 source tree.
335
336 =over 4
337
338 =item XXX-some-platform
339
340 XXX
341
342 =back
343
344 =head2 Discontinued Platforms
345
346 XXX List any platforms that this version of perl no longer compiles on.
347
348 =over 4
349
350 =item XXX-some-platform
351
352 XXX
353
354 =back
355
356 =head2 Platform-Specific Notes
357
358 XXX List any changes for specific platforms.  This could include configuration
359 and compilation changes or changes in portability/compatibility.  However,
360 changes within modules for platforms should generally be listed in the
361 L</Modules and Pragmata> section.
362
363 =over 4
364
365 =item XXX-some-platform
366
367 XXX
368
369 =back
370
371 =head1 Internal Changes
372
373 XXX Changes which affect the interface available to C<XS> code go here.  Other
374 significant internal changes for future core maintainers should be noted as
375 well.
376
377 [ List each change as an =item entry ]
378
379 =over 4
380
381 =item *
382
383 XXX
384
385 =back
386
387 =head1 Selected Bug Fixes
388
389 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
390 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
391
392 [ List each fix as an =item entry ]
393
394 =over 4
395
396 =item *
397
398 The in-place reverse optimisation now correctly strengthens weak
399 references using the L<C<sv_rvunweaken()>|perlapi/sv_rvunweaken>
400 API function.
401
402 =item *
403
404 Fixed a read before buffer when parsing a range starting with C<\N{}>
405 at the beginning of the character set for the transliteration
406 operator.  [perl #132245]
407
408 =item *
409
410 Fixed a leaked SV when parsing an empty C<\N{}> at compile-time.
411 [perl #132245]
412
413 =back
414
415 =head1 Known Problems
416
417 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
418 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
419 platform specific bugs also go here.
420
421 [ List each fix as an =item entry ]
422
423 =over 4
424
425 =item *
426
427 XXX
428
429 =back
430
431 =head1 Errata From Previous Releases
432
433 =over 4
434
435 =item *
436
437 XXX Add anything here that we forgot to add, or were mistaken about, in
438 the perldelta of a previous release.
439
440 =back
441
442 =head1 Obituary
443
444 XXX If any significant core contributor has died, we've added a short obituary
445 here.
446
447 =head1 Acknowledgements
448
449 XXX Generate this with:
450
451   perl Porting/acknowledgements.pl v5.27.5..HEAD
452
453 =head1 Reporting Bugs
454
455 If you find what you think is a bug, you might check the perl bug database
456 at L<https://rt.perl.org/> .  There may also be information at
457 L<http://www.perl.org/> , the Perl Home Page.
458
459 If you believe you have an unreported bug, please run the L<perlbug> program
460 included with your release.  Be sure to trim your bug down to a tiny but
461 sufficient test case.  Your bug report, along with the output of C<perl -V>,
462 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
463
464 If the bug you are reporting has security implications which make it
465 inappropriate to send to a publicly archived mailing list, then see
466 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
467 for details of how to report the issue.
468
469 =head1 Give Thanks
470
471 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
472 you can do so by running the C<perlthanks> program:
473
474     perlthanks
475
476 This will send an email to the Perl 5 Porters list with your show of thanks.
477
478 =head1 SEE ALSO
479
480 The F<Changes> file for an explanation of how to view exhaustive details on
481 what changed.
482
483 The F<INSTALL> file for how to build Perl.
484
485 The F<README> file for general stuff.
486
487 The F<Artistic> and F<Copying> files for copyright information.
488
489 =cut