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