This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta entry for Carp
[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.2
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.27.1 release and the 5.27.2
13 release.
14
15 If you are upgrading from an earlier release such as 5.27.0, first read
16 L<perl5271delta>, which describes differences between 5.27.0 and 5.27.1.
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 Unicode 10.0 is supported
31
32 A list of changes is at
33 L<http://www.unicode.org/versions/Unicode10.0.0>.
34
35 =head1 Security
36
37 XXX Any security-related notices go here.  In particular, any security
38 vulnerabilities closed should be noted here rather than in the
39 L</Selected Bug Fixes> section.
40
41 [ List each security issue as a =head2 entry ]
42
43 =head1 Incompatible Changes
44
45 XXX For a release on a stable branch, this section aspires to be:
46
47     There are no changes intentionally incompatible with 5.XXX.XXX
48     If any exist, they are bugs, and we request that you submit a
49     report.  See L</Reporting Bugs> below.
50
51 [ List each incompatible change as a =head2 entry ]
52
53 =head1 Deprecations
54
55 XXX Any deprecated features, syntax, modules etc. should be listed here.
56
57 =head2 Module removals
58
59 XXX Remove this section if inapplicable.
60
61 The following modules will be removed from the core distribution in a
62 future release, and will at that time need to be installed from CPAN.
63 Distributions on CPAN which require these modules will need to list them as
64 prerequisites.
65
66 The core versions of these modules will now issue C<"deprecated">-category
67 warnings to alert you to this fact.  To silence these deprecation warnings,
68 install the modules in question from CPAN.
69
70 Note that these are (with rare exceptions) fine modules that you are encouraged
71 to continue to use.  Their disinclusion from core primarily hinges on their
72 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
73 not usually on concerns over their design.
74
75 =over
76
77 =item XXX
78
79 XXX Note that deprecated modules should be listed here even if they are listed
80 as an updated module in the L</Modules and Pragmata> section.
81
82 =back
83
84 [ List each other deprecation as a =head2 entry ]
85
86 =head1 Performance Enhancements
87
88 XXX Changes which enhance performance without changing behaviour go here.
89 There may well be none in a stable release.
90
91 [ List each enhancement as a =item entry ]
92
93 =over 4
94
95 =item *
96
97 XXX
98
99 =back
100
101 =head1 Modules and Pragmata
102
103 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
104 go here.  If Module::CoreList is updated, generate an initial draft of the
105 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
106 for important changes should then be added by hand.  In an ideal world,
107 dual-life modules would have a F<Changes> file that could be cribbed.
108
109 [ Within each section, list entries as a =item entry ]
110
111 =head2 New Modules and Pragmata
112
113 =over 4
114
115 =item *
116
117 XXX
118
119 =back
120
121 =head2 Updated Modules and Pragmata
122
123 =over 4
124
125 =item *
126
127 L<XXX> has been upgraded from version A.xx to B.yy.
128
129 =item *
130
131 L<Carp> has been upgraded from version 1.42 to 1.43.
132
133 =item *
134
135 L<Cwd> has been upgraded from version 3.67 to 3.68.
136
137 =item *
138
139 L<ExtUtils::CBuilder> has been upgraded from version 0.280225 to 0.280227.
140
141 =item *
142
143 L<Time::HiRes> has been upgraded from version 1.9742 to 1.9743.
144
145 =back
146
147 =head2 Removed Modules and Pragmata
148
149 =over 4
150
151 =item *
152
153 XXX
154
155 =back
156
157 =head1 Documentation
158
159 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
160 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
161
162 =head2 New Documentation
163
164 XXX Changes which create B<new> files in F<pod/> go here.
165
166 =head3 L<XXX>
167
168 XXX Description of the purpose of the new file here
169
170 =head2 Changes to Existing Documentation
171
172 We have attempted to update the documentation to reflect the changes
173 listed in this document.  If you find any we have missed, send email
174 to L<perlbug@perl.org|mailto:perlbug@perl.org>.
175
176 XXX Changes which significantly change existing files in F<pod/> go here.
177 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
178 section.
179
180 Additionally, the following selected changes have been made:
181
182 =head3 L<XXX>
183
184 =over 4
185
186 =item *
187
188 XXX Description of the change here
189
190 =back
191
192 =head1 Diagnostics
193
194 The following additions or changes have been made to diagnostic output,
195 including warnings and fatal error messages.  For the complete list of
196 diagnostic messages, see L<perldiag>.
197
198 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
199 include any changes in L<perldiag> that reconcile it to the C<C> code.
200
201 =head2 New Diagnostics
202
203 XXX Newly added diagnostic messages go under here, separated into New Errors
204 and New Warnings
205
206 =head3 New Errors
207
208 =over 4
209
210 =item *
211
212 XXX L<message|perldiag/"message">
213
214 =back
215
216 =head3 New Warnings
217
218 =over 4
219
220 =item *
221
222 XXX L<message|perldiag/"message">
223
224 =back
225
226 =head2 Changes to Existing Diagnostics
227
228 XXX Changes (i.e. rewording) of diagnostic messages go here
229
230 =over 4
231
232 =item *
233
234 XXX Describe change here
235
236 =back
237
238 =head1 Utility Changes
239
240 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
241 Most of these are built within the directory F<utils>.
242
243 [ List utility changes as a =head2 entry for each utility and =item
244 entries for each change
245 Use L<XXX> with program names to get proper documentation linking. ]
246
247 =head2 L<XXX>
248
249 =over 4
250
251 =item *
252
253 XXX
254
255 =back
256
257 =head1 Configuration and Compilation
258
259 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
260 go here.  Any other changes to the Perl build process should be listed here.
261 However, any platform-specific changes should be listed in the
262 L</Platform Support> section, instead.
263
264 [ List changes as a =item entry ].
265
266 =over 4
267
268 =item *
269
270 XXX
271
272 =back
273
274 =head1 Testing
275
276 XXX Any significant changes to the testing of a freshly built perl should be
277 listed here.  Changes which create B<new> files in F<t/> go here as do any
278 large changes to the testing harness (e.g. when parallel testing was added).
279 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
280 that they represent may be covered elsewhere.
281
282 XXX If there were no significant test changes, say this:
283
284 Tests were added and changed to reflect the other additions and changes
285 in this release.
286
287 XXX If instead there were significant changes, say this:
288
289 Tests were added and changed to reflect the other additions and
290 changes in this release.  Furthermore, these significant changes were
291 made:
292
293 [ List each test improvement as a =item entry ]
294
295 =over 4
296
297 =item *
298
299 XXX
300
301 =back
302
303 =head1 Platform Support
304
305 XXX Any changes to platform support should be listed in the sections below.
306
307 [ Within the sections, list each platform as a =item entry with specific
308 changes as paragraphs below it. ]
309
310 =head2 New Platforms
311
312 XXX List any platforms that this version of perl compiles on, that previous
313 versions did not.  These will either be enabled by new files in the F<hints/>
314 directories, or new subdirectories and F<README> files at the top level of the
315 source tree.
316
317 =over 4
318
319 =item XXX-some-platform
320
321 XXX
322
323 =back
324
325 =head2 Discontinued Platforms
326
327 XXX List any platforms that this version of perl no longer compiles on.
328
329 =over 4
330
331 =item XXX-some-platform
332
333 XXX
334
335 =back
336
337 =head2 Platform-Specific Notes
338
339 XXX List any changes for specific platforms.  This could include configuration
340 and compilation changes or changes in portability/compatibility.  However,
341 changes within modules for platforms should generally be listed in the
342 L</Modules and Pragmata> section.
343
344 =over 4
345
346 =item XXX-some-platform
347
348 XXX
349
350 =back
351
352 =head1 Internal Changes
353
354 XXX Changes which affect the interface available to C<XS> code go here.  Other
355 significant internal changes for future core maintainers should be noted as
356 well.
357
358 [ List each change as a =item entry ]
359
360 =over 4
361
362 =item *
363
364 XXX
365
366 =back
367
368 =head1 Selected Bug Fixes
369
370 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
371 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
372
373 [ List each fix as a =item entry ]
374
375 =over 4
376
377 =item *
378
379 List assignment (C<aassign>) could in some rare cases allocate an
380 entry on the mortal stack and leave the entry uninitialized. [perl
381 #131570]
382
383 =item *
384
385 Attempting to apply an attribute to an C<our> variable where a
386 function of that name already exists could result in a NULL pointer
387 being supplied where an SV was expected, crashing perl.  [perl
388 #131597]
389
390 =item *
391
392 C<split ' '> now correctly handles the argument being split when in the
393 scope of the L<< C<unicode_strings>|feature/"The 'unicode_strings' feature"
394 >> feature. Previously, when a string using the single-byte internal
395 representation contained characters that are whitespace by Unicode rules but
396 not by ASCII rules, it treated those characters as part of fields rather
397 than as field separators.  [perl #130907]
398
399 =item *
400
401 Several built-in functions previously had bugs that could cause them to
402 write to the internal stack without allocating room for the item being
403 written. In rare situations, this could have led to a crash. These bugs have
404 now been fixed, and if any similar bugs are introduced in future, they will
405 be detected automatically in debugging builds.
406
407 =item *
408
409 Using a symbolic ref with postderef syntax as the key in a hash lookup was
410 yielding an assertion failure on debugging builds. [perl #131627]
411
412 =item *
413
414 Array and hash variables whose names begin with a caret now admit indexing
415 inside their curlies when interpolated into strings, as in C<<
416 "${^CAPTURE[0]}" >> to index C<@{^CAPTURE}>.  [perl #131664]
417
418 =back
419
420 =head1 Known Problems
421
422 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
423 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
424 platform specific bugs also go here.
425
426 [ List each fix as a =item entry ]
427
428 =over 4
429
430 =item *
431
432 XXX
433
434 =back
435
436 =head1 Errata From Previous Releases
437
438 =over 4
439
440 =item *
441
442 XXX Add anything here that we forgot to add, or were mistaken about, in
443 the perldelta of a previous release.
444
445 =back
446
447 =head1 Obituary
448
449 XXX If any significant core contributor has died, we've added a short obituary
450 here.
451
452 =head1 Acknowledgements
453
454 XXX Generate this with:
455
456   perl Porting/acknowledgements.pl v5.25.5..HEAD
457
458 =head1 Reporting Bugs
459
460 If you find what you think is a bug, you might check the perl bug database
461 at L<https://rt.perl.org/> .  There may also be information at
462 L<http://www.perl.org/> , the Perl Home Page.
463
464 If you believe you have an unreported bug, please run the L<perlbug> program
465 included with your release.  Be sure to trim your bug down to a tiny but
466 sufficient test case.  Your bug report, along with the output of C<perl -V>,
467 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
468
469 If the bug you are reporting has security implications which make it
470 inappropriate to send to a publicly archived mailing list, then see
471 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
472 for details of how to report the issue.
473
474 =head1 Give Thanks
475
476 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
477 you can do so by running the C<perlthanks> program:
478
479     perlthanks
480
481 This will send an email to the Perl 5 Porters list with your show of thanks.
482
483 =head1 SEE ALSO
484
485 The F<Changes> file for an explanation of how to view exhaustive details on
486 what changed.
487
488 The F<INSTALL> file for how to build Perl.
489
490 The F<README> file for general stuff.
491
492 The F<Artistic> and F<Copying> files for copyright information.
493
494 =cut