perldelta for 47a83dc69df7, c345ac2ecadb, 728ecd1a3998, f2a60c1f79f4
[perl.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 The C<dtrace> build process has further changes:
340
341 =over
342
343 =item *
344
345 If the C<-xnolibs> is available, use that so a F<dtrace> perl can be
346 built within a FreeBSD jail.
347
348 =item *
349
350 On systems that build a dtrace object file (FreeBSD, Solaris and
351 SystemTap's dtrace emulation), copy the input objects to a separate
352 directory and process them there, and use those objects in the link,
353 since C<dtrace -G> also modifies these objects.
354
355 =item *
356
357 Add libelf to the build on FreeBSD 10.x, since dtrace adds references
358 to libelf symbols.
359
360 =item *
361
362 Generate a dummy dtrace_main.o if C<dtrace -G> fails to build it.  A
363 default build on Solaris generates probes from the unused inline
364 functions, while they don't on FreeBSD, which causes C<dtrace -G> to
365 fail.
366
367 =back
368
369 [perl #130108]
370
371 =back
372
373 =head1 Testing
374
375 XXX Any significant changes to the testing of a freshly built perl should be
376 listed here.  Changes which create B<new> files in F<t/> go here as do any
377 large changes to the testing harness (e.g. when parallel testing was added).
378 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
379 that they represent may be covered elsewhere.
380
381 [ List each test improvement as a =item entry ]
382
383 =over 4
384
385 =item *
386
387 XXX
388
389 =back
390
391 =head1 Platform Support
392
393 XXX Any changes to platform support should be listed in the sections below.
394
395 [ Within the sections, list each platform as a =item entry with specific
396 changes as paragraphs below it. ]
397
398 =head2 New Platforms
399
400 XXX List any platforms that this version of perl compiles on, that previous
401 versions did not.  These will either be enabled by new files in the F<hints/>
402 directories, or new subdirectories and F<README> files at the top level of the
403 source tree.
404
405 =over 4
406
407 =item XXX-some-platform
408
409 XXX
410
411 =back
412
413 =head2 Discontinued Platforms
414
415 XXX List any platforms that this version of perl no longer compiles on.
416
417 =over 4
418
419 =item XXX-some-platform
420
421 XXX
422
423 =back
424
425 =head2 Platform-Specific Notes
426
427 XXX List any changes for specific platforms.  This could include configuration
428 and compilation changes or changes in portability/compatibility.  However,
429 changes within modules for platforms should generally be listed in the
430 L</Modules and Pragmata> section.
431
432 =over 4
433
434 =item XXX-some-platform
435
436 XXX
437
438 =back
439
440 =head1 Internal Changes
441
442 XXX Changes which affect the interface available to C<XS> code go here.  Other
443 significant internal changes for future core maintainers should be noted as
444 well.
445
446 [ List each change as a =item entry ]
447
448 =over 4
449
450 =item *
451
452 New versions of macros like C<isALPHA_utf8> and C<toLOWER_utf8>  have
453 been added, each with the
454 suffix C<_safe>, like C<isSPACE_utf8_safe>.  These take an extra
455 parameter, giving an upper limit of how far into the string it is safe
456 to read.  Using the old versions could cause attempts to read beyond the
457 end of the input buffer if the UTF-8 is not well-formed, and ther use
458 now raises a deprecation warning.  Details are at
459 L<perlapi/Character classification>.
460
461 =item *
462
463 Calling macros like C<isALPHA_utf8> on malformed UTF-8 have issued a
464 deprecation warning since Perl v5.18.  They now die.
465 Similarly, macros like C<toLOWER_utf8> on malformed UTF-8 now die.
466
467 =item *
468
469 Calling the functions C<utf8n_to_uvchr> and its derivatives, while
470 passing a string length of 0 is now asserted against in DEBUGGING
471 builds, and otherwise returns the Unicode REPLACEMENT CHARACTER.   If
472 you have nothing to decode, you shouldn't call the decode function.
473
474 =item *
475
476 The functions C<utf8n_to_uvchr> and its derivatives now return the
477 Unicode REPLACEMENT CHARACTER if called with UTF-8 that has the overlong
478 malformation, and that malformation is allowed by the input parameters.
479 This malformation is where the UTF-8 looks valid syntactically, but
480 there is a shorter sequence that yields the same code point.  This has
481 been forbidden since Unicode version 3.1.
482
483 =item *
484
485 The functions C<utf8n_to_uvchr> and its derivatives now accept an input
486 flag to allow the overflow malformation.  This malformation is when the
487 UTF-8 may be syntactically valid, but the code point it represents is
488 not capable of being represented in the word length on the platform.
489 What "allowed" means in this case is that the function doesn't return an
490 error, and advances the parse pointer to beyond the UTF-8 in question,
491 but it returns the Unicode REPLACEMENT CHARACTER as the value of the
492 code point (since the real value is not representable).
493
494 =back
495
496 =head1 Selected Bug Fixes
497
498 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
499 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
500
501 [ List each fix as a =item entry ]
502
503 =over 4
504
505 =item *
506
507 Under C<use utf8>, the entire Perl program is now checked that the UTF-8
508 is wellformed.  This resolves [perl #126310].
509
510 =back
511
512 =head1 Known Problems
513
514 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
515 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
516 platform specific bugs also go here.
517
518 [ List each fix as a =item entry ]
519
520 =over 4
521
522 =item *
523
524 XXX
525
526 =back
527
528 =head1 Errata From Previous Releases
529
530 =over 4
531
532 =item *
533
534 XXX Add anything here that we forgot to add, or were mistaken about, in
535 the perldelta of a previous release.
536
537 =back
538
539 =head1 Obituary
540
541 XXX If any significant core contributor has died, we've added a short obituary
542 here.
543
544 =head1 Acknowledgements
545
546 XXX Generate this with:
547
548   perl Porting/acknowledgements.pl v5.25.5..HEAD
549
550 =head1 Reporting Bugs
551
552 If you find what you think is a bug, you might check the perl bug database
553 at L<https://rt.perl.org/> .  There may also be information at
554 L<http://www.perl.org/> , the Perl Home Page.
555
556 If you believe you have an unreported bug, please run the L<perlbug> program
557 included with your release.  Be sure to trim your bug down to a tiny but
558 sufficient test case.  Your bug report, along with the output of C<perl -V>,
559 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
560
561 If the bug you are reporting has security implications which make it
562 inappropriate to send to a publicly archived mailing list, then see
563 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
564 for details of how to report the issue.
565
566 =head1 SEE ALSO
567
568 The F<Changes> file for an explanation of how to view exhaustive details on
569 what changed.
570
571 The F<INSTALL> file for how to build Perl.
572
573 The F<README> file for general stuff.
574
575 The F<Artistic> and F<Copying> files for copyright information.
576
577 =cut