This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
ffd2c5f2f62263fe0d83552e3f78e309dbf8aa7b
[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.1
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.27.0 release and the 5.27.1
13 release.
14
15 If you are upgrading from an earlier release such as 5.26.0, first read
16 L<perl5270delta>, which describes differences between 5.26.0 and 5.27.0.
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 L<C<delete>|perlfunc/delete EXPR> on key/value slices
31
32 L<C<delete>|perlfunc/delete EXPR> can now be used on key/value slices,
33 returning the keys along with the deleted values.
34 L<[perl #131328]|https://rt.perl.org/Ticket/Display.html?id=131328>
35
36 =head1 Security
37
38 XXX Any security-related notices go here.  In particular, any security
39 vulnerabilities closed should be noted here rather than in the
40 L</Selected Bug Fixes> section.
41
42 [ List each security issue as a =head2 entry ]
43
44 =head1 Incompatible Changes
45
46 XXX For a release on a stable branch, this section aspires to be:
47
48     There are no changes intentionally incompatible with 5.XXX.XXX
49     If any exist, they are bugs, and we request that you submit a
50     report.  See L</Reporting Bugs> below.
51
52 [ List each incompatible change as a =head2 entry ]
53
54 =head2 Comma-less variable lists in formats are no longer allowed
55
56 Omitting the commas between variables passed to formats is no longer
57 allowed.  This has been deprecated since Perl 5.000.
58
59 =head2 The C<:locked> and C<:unique> attributes have been removed
60
61 These have been no-ops and deprecated since Perl 5.12 and 5.10,
62 respectively.
63
64 =head2 C<\N{}> with nothing between the braces is now illegal.
65
66 This has been deprecated since Perl 5.24.
67
68 =head2 Opening the same symbol as both a file and directory handle is no longer allowed
69
70 Using open() and opendir() to associate both a filehandle and a dirhandle
71 to the same symbol (glob or scalar) has been deprecated since Perl 5.10.
72
73 =head1 Deprecations
74
75 XXX Any deprecated features, syntax, modules etc. should be listed here.
76
77 =head2 Use of L<C<vec>|perlfunc/vec EXPR,OFFSET,BITS> on strings with code
78 points above 0xFF is deprecated.
79
80 Use of these is nonsensical, as C<vec> is a bit-oriented operation,
81 which operates on the underlying UTF-8 representation these strings must
82 be in, and will likely give unexpected results.
83
84 =head2 Some uses of unescaped C<"{"> are no longer fatal
85
86 Perl 5.26.0 fatalized some uses of an unescaped left brace, but an
87 exception was made at the last minute, specifically crafted to be a
88 minimal change to allow GNU Autoconf to work.  This code is heavily
89 depended upon, and continues to use the deprecated usage.  Its use of an
90 unescaped left brace is one where we have no intention of repurposing
91 C<"{"> to be something other than itself.
92
93 That exception is now generalized to include various other such cases
94 where the C<"{"> will not be repurposed.  This is to get real experience
95 with this more complicated change now, in case we need to issue a dot
96 release if we find other things like Autoconf that are important to work
97 around.
98
99 Note that these uses continue to raise a deprecation message.
100
101 =head2 Module removals
102
103 XXX Remove this section if inapplicable.
104
105 The following modules will be removed from the core distribution in a
106 future release, and will at that time need to be installed from CPAN.
107 Distributions on CPAN which require these modules will need to list them as
108 prerequisites.
109
110 The core versions of these modules will now issue C<"deprecated">-category
111 warnings to alert you to this fact.  To silence these deprecation warnings,
112 install the modules in question from CPAN.
113
114 Note that these are (with rare exceptions) fine modules that you are encouraged
115 to continue to use.  Their disinclusion from core primarily hinges on their
116 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
117 not usually on concerns over their design.
118
119 =over
120
121 =item XXX
122
123 XXX Note that deprecated modules should be listed here even if they are listed
124 as an updated module in the L</Modules and Pragmata> section.
125
126 =back
127
128 [ List each other deprecation as a =head2 entry ]
129
130 =head1 Performance Enhancements
131
132 XXX Changes which enhance performance without changing behaviour go here.
133 There may well be none in a stable release.
134
135 [ List each enhancement as a =item entry ]
136
137 =over 4
138
139 =item *
140
141 XXX
142
143 =back
144
145 =head1 Modules and Pragmata
146
147 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
148 go here.  If Module::CoreList is updated, generate an initial draft of the
149 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
150 for important changes should then be added by hand.  In an ideal world,
151 dual-life modules would have a F<Changes> file that could be cribbed.
152
153 [ Within each section, list entries as a =item entry ]
154
155 =head2 New Modules and Pragmata
156
157 =over 4
158
159 =item *
160
161 XXX
162
163 =back
164
165 =head2 Updated Modules and Pragmata
166
167 =over 4
168
169 =item *
170
171 L<XXX> has been upgraded from version A.xx to B.yy.
172
173 =back
174
175 =head2 Removed Modules and Pragmata
176
177 =over 4
178
179 =item *
180
181 XXX
182
183 =back
184
185 =head1 Documentation
186
187 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
188 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
189
190 =head2 New Documentation
191
192 XXX Changes which create B<new> files in F<pod/> go here.
193
194 =head3 L<XXX>
195
196 XXX Description of the purpose of the new file here
197
198 =head2 Changes to Existing Documentation
199
200 XXX Changes which significantly change existing files in F<pod/> go here.
201 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
202 section.
203
204 =head3 L<XXX>
205
206 =over 4
207
208 =item *
209
210 XXX Description of the change here
211
212 =back
213
214 =head1 Diagnostics
215
216 The following additions or changes have been made to diagnostic output,
217 including warnings and fatal error messages.  For the complete list of
218 diagnostic messages, see L<perldiag>.
219
220 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
221 include any changes in L<perldiag> that reconcile it to the C<C> code.
222
223 =head2 New Diagnostics
224
225 XXX Newly added diagnostic messages go under here, separated into New Errors
226 and New Warnings
227
228 =head3 New Errors
229
230 =over 4
231
232 =item *
233
234 XXX L<message|perldiag/"message">
235
236 =back
237
238 =head3 New Warnings
239
240 =over 4
241
242 =item *
243
244 XXX L<message|perldiag/"message">
245
246 =back
247
248 =head2 Changes to Existing Diagnostics
249
250 XXX Changes (i.e. rewording) of diagnostic messages go here
251
252 =over 4
253
254 =item *
255
256 XXX Describe change here
257
258 =back
259
260 =head1 Utility Changes
261
262 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
263 Most of these are built within the directory F<utils>.
264
265 [ List utility changes as a =head2 entry for each utility and =item
266 entries for each change
267 Use L<XXX> with program names to get proper documentation linking. ]
268
269 =head2 L<XXX>
270
271 =over 4
272
273 =item *
274
275 XXX
276
277 =back
278
279 =head1 Configuration and Compilation
280
281 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
282 go here.  Any other changes to the Perl build process should be listed here.
283 However, any platform-specific changes should be listed in the
284 L</Platform Support> section, instead.
285
286 [ List changes as a =item entry ].
287
288 =over 4
289
290 =item *
291
292 XXX
293
294 =back
295
296 =head1 Testing
297
298 XXX Any significant changes to the testing of a freshly built perl should be
299 listed here.  Changes which create B<new> files in F<t/> go here as do any
300 large changes to the testing harness (e.g. when parallel testing was added).
301 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
302 that they represent may be covered elsewhere.
303
304 [ List each test improvement as a =item entry ]
305
306 =over 4
307
308 =item *
309
310 XXX
311
312 =back
313
314 =head1 Platform Support
315
316 XXX Any changes to platform support should be listed in the sections below.
317
318 [ Within the sections, list each platform as a =item entry with specific
319 changes as paragraphs below it. ]
320
321 =head2 New Platforms
322
323 XXX List any platforms that this version of perl compiles on, that previous
324 versions did not.  These will either be enabled by new files in the F<hints/>
325 directories, or new subdirectories and F<README> files at the top level of the
326 source tree.
327
328 =over 4
329
330 =item XXX-some-platform
331
332 XXX
333
334 =back
335
336 =head2 Discontinued Platforms
337
338 XXX List any platforms that this version of perl no longer compiles on.
339
340 =over 4
341
342 =item XXX-some-platform
343
344 XXX
345
346 =back
347
348 =head2 Platform-Specific Notes
349
350 XXX List any changes for specific platforms.  This could include configuration
351 and compilation changes or changes in portability/compatibility.  However,
352 changes within modules for platforms should generally be listed in the
353 L</Modules and Pragmata> section.
354
355 =over 4
356
357 =item XXX-some-platform
358
359 XXX
360
361 =back
362
363 =head1 Internal Changes
364
365 XXX Changes which affect the interface available to C<XS> code go here.  Other
366 significant internal changes for future core maintainers should be noted as
367 well.
368
369 [ List each change as a =item entry ]
370
371 =over 4
372
373 =item *
374
375 The C<PL_statbuf> interpreter variable has been removed.
376
377 =item *
378
379 The deprecated function C<to_utf8_case()>, accessible from XS code, has
380 been removed.
381
382 =back
383
384 =head1 Selected Bug Fixes
385
386 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
387 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
388
389 [ List each fix as a =item entry ]
390
391 =over 4
392
393 =item *
394
395 XXX
396
397 =back
398
399 =head1 Known Problems
400
401 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
402 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
403 platform specific bugs also go here.
404
405 [ List each fix as a =item entry ]
406
407 =over 4
408
409 =item *
410
411 XXX
412
413 =back
414
415 =head1 Errata From Previous Releases
416
417 =over 4
418
419 =item *
420
421 XXX Add anything here that we forgot to add, or were mistaken about, in
422 the perldelta of a previous release.
423
424 =back
425
426 =head1 Obituary
427
428 XXX If any significant core contributor has died, we've added a short obituary
429 here.
430
431 =head1 Acknowledgements
432
433 XXX Generate this with:
434
435   perl Porting/acknowledgements.pl v5.25.5..HEAD
436
437 =head1 Reporting Bugs
438
439 If you find what you think is a bug, you might check the perl bug database
440 at L<https://rt.perl.org/> .  There may also be information at
441 L<http://www.perl.org/> , the Perl Home Page.
442
443 If you believe you have an unreported bug, please run the L<perlbug> program
444 included with your release.  Be sure to trim your bug down to a tiny but
445 sufficient test case.  Your bug report, along with the output of C<perl -V>,
446 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
447
448 If the bug you are reporting has security implications which make it
449 inappropriate to send to a publicly archived mailing list, then see
450 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
451 for details of how to report the issue.
452
453 =head1 Give Thanks
454
455 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
456 you can do so by running the C<perlthanks> program:
457
458     perlthanks
459
460 This will send an email to the Perl 5 Porters list with your show of thanks.
461
462 =head1 SEE ALSO
463
464 The F<Changes> file for an explanation of how to view exhaustive details on
465 what changed.
466
467 The F<INSTALL> file for how to build Perl.
468
469 The F<README> file for general stuff.
470
471 The F<Artistic> and F<Copying> files for copyright information.
472
473 =cut