This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for adf9095d629bebb27169b0f3b03f75ee974da100
[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.25.9
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.25.8 release and the 5.25.9
13 release.
14
15 If you are upgrading from an earlier release such as 5.25.7, first read
16 L<perl5258delta>, which describes differences between 5.25.7 and 5.25.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 =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 =head2 String delimiters that aren't stand-alone graphemes are now
51 deprecated
52
53 In order for Perl to eventually allow string delimiters to be Unicode
54 grapheme clusters (which look like a single character, but may be
55 a sequence of several ones), we have to stop allowing a single char
56 delimiter that isn't a grapheme by itself.  These are unlikely to exist
57 in actual code, as they would typically display as attached to the
58 character in front of them.
59
60 =head2 Module removals
61
62 XXX Remove this section if inapplicable.
63
64 The following modules will be removed from the core distribution in a
65 future release, and will at that time need to be installed from CPAN.
66 Distributions on CPAN which require these modules will need to list them as
67 prerequisites.
68
69 The core versions of these modules will now issue C<"deprecated">-category
70 warnings to alert you to this fact.  To silence these deprecation warnings,
71 install the modules in question from CPAN.
72
73 Note that these are (with rare exceptions) fine modules that you are encouraged
74 to continue to use.  Their disinclusion from core primarily hinges on their
75 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
76 not usually on concerns over their design.
77
78 =over
79
80 =item XXX
81
82 XXX Note that deprecated modules should be listed here even if they are listed
83 as an updated module in the L</Modules and Pragmata> section.
84
85 =back
86
87 [ List each other deprecation as a =head2 entry ]
88
89 =head1 Performance Enhancements
90
91 XXX Changes which enhance performance without changing behaviour go here.
92 There may well be none in a stable release.
93
94 [ List each enhancement as a =item entry ]
95
96 =over 4
97
98 =item *
99
100 XXX
101
102 =back
103
104 =head1 Modules and Pragmata
105
106 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
107 go here.  If Module::CoreList is updated, generate an initial draft of the
108 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
109 for important changes should then be added by hand.  In an ideal world,
110 dual-life modules would have a F<Changes> file that could be cribbed.
111
112 [ Within each section, list entries as a =item entry ]
113
114 =head2 New Modules and Pragmata
115
116 =over 4
117
118 =item *
119
120 XXX
121
122 =back
123
124 =head2 Updated Modules and Pragmata
125
126 =over 4
127
128 =item *
129
130 L<XXX> has been upgraded from version A.xx to B.yy.
131
132 =item *
133
134 L<B::Xref> has been upgraded from version 1.05 to 1.06.
135
136 =item *
137
138 L<Compress::Raw::Bzip2> has been upgraded from version 2.069 to 2.070.
139
140 =item *
141
142 L<Compress::Raw::Zlib> has been upgraded from version 2.069 to 2.070.
143
144 =item *
145
146 L<DB_File> has been upgraded from version 1.838 to 1.840.
147
148 =item *
149
150 L<Devel::SelfStubber> has been upgraded from version 1.05 to 1.06.
151
152 =item *
153
154 L<diagnostics> has been upgraded from version 1.35 to 1.36.
155
156 =item *
157
158 L<DynaLoader> has been upgraded from version 1.40 to 1.41.
159
160 =item *
161
162 L<Errno> has been upgraded from version 1.27 to 1.28.
163
164 =item *
165
166 L<ExtUtils::Embed> has been upgraded from version 1.33 to 1.34.
167
168 =item *
169
170 L<I18N::LangTags> has been upgraded from version 0.41 to 0.42.
171
172 =item *
173
174 L<lib> has been upgraded from version 0.63 to 0.64.
175
176 =item *
177
178 L<Module::CoreList> has been upgraded from version 5.20161220 to 5.20170120.
179
180 =item *
181
182 L<OS2::Process> has been upgraded from version 1.11 to 1.12.
183
184 =item *
185
186 L<perl5db.pl> has been upgraded from version 1.50 to 1.51.
187
188 =item *
189
190 L<Storable> has been upgraded from version 2.59 to 2.61.
191
192 =item *
193
194 L<Symbol> has been upgraded from version 1.07 to 1.08.
195
196 =item *
197
198 L<Term::ReadLine> has been upgraded from version 1.15 to 1.16.
199
200 =item *
201
202 L<Test> has been upgraded from version 1.29 to 1.30.
203
204 =item *
205
206 L<threads::shared> has been upgraded from version 1.52 to 1.53.
207
208 =item *
209
210 L<Unicode::UCD> has been upgraded from version 0.67 to 0.68.
211
212 =item *
213
214 L<VMS::DCLsym> has been upgraded from version 1.07 to 1.08.
215
216 =item *
217
218 L<XSLoader> has been upgraded from version 0.24 to 0.26.
219
220 =back
221
222 =head2 Removed Modules and Pragmata
223
224 =over 4
225
226 =item *
227
228 XXX
229
230 =back
231
232 =head1 Documentation
233
234 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
235 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
236
237 =head2 New Documentation
238
239 XXX Changes which create B<new> files in F<pod/> go here.
240
241 =head3 L<XXX>
242
243 XXX Description of the purpose of the new file here
244
245 =head2 Changes to Existing Documentation
246
247 XXX Changes which significantly change existing files in F<pod/> go here.
248 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
249 section.
250
251 =head3 L<XXX>
252
253 =over 4
254
255 =item *
256
257 XXX Description of the change here
258
259 =back
260
261 =head1 Diagnostics
262
263 The following additions or changes have been made to diagnostic output,
264 including warnings and fatal error messages.  For the complete list of
265 diagnostic messages, see L<perldiag>.
266
267 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
268 include any changes in L<perldiag> that reconcile it to the C<C> code.
269
270 =head2 New Diagnostics
271
272 XXX Newly added diagnostic messages go under here, separated into New Errors
273 and New Warnings
274
275 =head3 New Errors
276
277 =over 4
278
279 =item *
280
281 XXX L<message|perldiag/"message">
282
283 =back
284
285 =head3 New Warnings
286
287 =over 4
288
289 =item *
290
291 XXX L<message|perldiag/"message">
292
293 =back
294
295 =head2 Changes to Existing Diagnostics
296
297 XXX Changes (i.e. rewording) of diagnostic messages go here
298
299 =over 4
300
301 =item *
302
303 XXX Describe change here
304
305 =back
306
307 =head1 Utility Changes
308
309 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
310 Most of these are built within the directory F<utils>.
311
312 [ List utility changes as a =head2 entry for each utility and =item
313 entries for each change
314 Use L<XXX> with program names to get proper documentation linking. ]
315
316 =head2 L<XXX>
317
318 =over 4
319
320 =item *
321
322 XXX
323
324 =back
325
326 =head1 Configuration and Compilation
327
328 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
329 go here.  Any other changes to the Perl build process should be listed here.
330 However, any platform-specific changes should be listed in the
331 L</Platform Support> section, instead.
332
333 [ List changes as a =item entry ].
334
335 =over 4
336
337 =item *
338
339 XXX
340
341 =back
342
343 =head1 Testing
344
345 XXX Any significant changes to the testing of a freshly built perl should be
346 listed here.  Changes which create B<new> files in F<t/> go here as do any
347 large changes to the testing harness (e.g. when parallel testing was added).
348 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
349 that they represent may be covered elsewhere.
350
351 [ List each test improvement as a =item entry ]
352
353 =over 4
354
355 =item *
356
357 XXX
358
359 =back
360
361 =head1 Platform Support
362
363 XXX Any changes to platform support should be listed in the sections below.
364
365 [ Within the sections, list each platform as a =item entry with specific
366 changes as paragraphs below it. ]
367
368 =head2 New Platforms
369
370 XXX List any platforms that this version of perl compiles on, that previous
371 versions did not.  These will either be enabled by new files in the F<hints/>
372 directories, or new subdirectories and F<README> files at the top level of the
373 source tree.
374
375 =over 4
376
377 =item XXX-some-platform
378
379 XXX
380
381 =back
382
383 =head2 Discontinued Platforms
384
385 XXX List any platforms that this version of perl no longer compiles on.
386
387 =over 4
388
389 =item XXX-some-platform
390
391 XXX
392
393 =back
394
395 =head2 Platform-Specific Notes
396
397 XXX List any changes for specific platforms.  This could include configuration
398 and compilation changes or changes in portability/compatibility.  However,
399 changes within modules for platforms should generally be listed in the
400 L</Modules and Pragmata> section.
401
402 =over 4
403
404 =item XXX-some-platform
405
406 XXX
407
408 =back
409
410 =head1 Internal Changes
411
412 XXX Changes which affect the interface available to C<XS> code go here.  Other
413 significant internal changes for future core maintainers should be noted as
414 well.
415
416 [ List each change as a =item entry ]
417
418 =over 4
419
420 =item *
421
422 New versions of macros like C<isALPHA_utf8> and C<toLOWER_utf8>  have
423 been added, each with the
424 suffix C<_safe>, like C<isSPACE_utf8_safe>.  These take an extra
425 parameter, giving an upper limit of how far into the string it is safe
426 to read.  Using the old versions could cause attempts to read beyond the
427 end of the input buffer if the UTF-8 is not well-formed, and ther use
428 now raises a deprecation warning.  Details are at
429 L<perlapi/Character classification>.
430
431 =item *
432
433 Calling macros like C<isALPHA_utf8> on malformed UTF-8 have issued a
434 deprecation warning since Perl v5.18.  They now die.
435 Similarly, macros like C<toLOWER_utf8> on malformed UTF-8 now die.
436
437 =item *
438
439 Calling the functions C<utf8n_to_uvchr> and its derivatives, while
440 passing a string length of 0 is now asserted against in DEBUGGING
441 builds, and otherwise returns the Unicode REPLACEMENT CHARACTER.   If
442 you have nothing to decode, you shouldn't call the decode function.
443
444 =item *
445
446 The functions C<utf8n_to_uvchr> and its derivatives now return the
447 Unicode REPLACEMENT CHARACTER if called with UTF-8 that has the overlong
448 malformation, and that malformation is allowed by the input parameters.
449 This malformation is where the UTF-8 looks valid syntactically, but
450 there is a shorter sequence that yields the same code point.  This has
451 been forbidden since Unicode version 3.1.
452
453 =item *
454
455 The functions C<utf8n_to_uvchr> and its derivatives now accept an input
456 flag to allow the overflow malformation.  This malformation is when the
457 UTF-8 may be syntactically valid, but the code point it represents is
458 not capable of being represented in the word length on the platform.
459 What "allowed" means in this case is that the function doesn't return an
460 error, and advances the parse pointer to beyond the UTF-8 in question,
461 but it returns the Unicode REPLACEMENT CHARACTER as the value of the
462 code point (since the real value is not representable).
463
464 =back
465
466 =head1 Selected Bug Fixes
467
468 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
469 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
470
471 [ List each fix as a =item entry ]
472
473 =over 4
474
475 =item *
476
477 Under C<use utf8>, the entire Perl program is now checked that the UTF-8
478 is wellformed.  This resolves [perl #126310].
479
480 =back
481
482 =head1 Known Problems
483
484 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
485 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
486 platform specific bugs also go here.
487
488 [ List each fix as a =item entry ]
489
490 =over 4
491
492 =item *
493
494 XXX
495
496 =back
497
498 =head1 Errata From Previous Releases
499
500 =over 4
501
502 =item *
503
504 XXX Add anything here that we forgot to add, or were mistaken about, in
505 the perldelta of a previous release.
506
507 =back
508
509 =head1 Obituary
510
511 XXX If any significant core contributor has died, we've added a short obituary
512 here.
513
514 =head1 Acknowledgements
515
516 XXX Generate this with:
517
518   perl Porting/acknowledgements.pl v5.25.5..HEAD
519
520 =head1 Reporting Bugs
521
522 If you find what you think is a bug, you might check the perl bug database
523 at L<https://rt.perl.org/> .  There may also be information at
524 L<http://www.perl.org/> , the Perl Home Page.
525
526 If you believe you have an unreported bug, please run the L<perlbug> program
527 included with your release.  Be sure to trim your bug down to a tiny but
528 sufficient test case.  Your bug report, along with the output of C<perl -V>,
529 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
530
531 If the bug you are reporting has security implications which make it
532 inappropriate to send to a publicly archived mailing list, then see
533 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
534 for details of how to report the issue.
535
536 =head1 SEE ALSO
537
538 The F<Changes> file for an explanation of how to view exhaustive details on
539 what changed.
540
541 The F<INSTALL> file for how to build Perl.
542
543 The F<README> file for general stuff.
544
545 The F<Artistic> and F<Copying> files for copyright information.
546
547 =cut