This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta - Update with remaining changes
[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.21.11
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.21.10 release and the 5.21.11
13 release.
14
15 If you are upgrading from an earlier release such as 5.21.9, first read
16 L<perl52110delta>, which describes differences between 5.21.9 and 5.21.10.
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 XXX Any deprecated features, syntax, modules etc. should be listed here.
51
52 =head2 Making all warnings fatal is discouraged
53
54 The documentation for L<fatal warnings|warnings/Fatal Warnings> notes
55 that C<< use warnings FATAL => 'all' >> is discouraged
56 and provides stronger language about the risks of fatal warnings
57 in general.
58
59 =head2 Module removals
60
61 XXX Remove this section if inapplicable.
62
63 The following modules will be removed from the core distribution in a
64 future release, and will at that time need to be installed from CPAN.
65 Distributions on CPAN which require these modules will need to list them as
66 prerequisites.
67
68 The core versions of these modules will now issue C<"deprecated">-category
69 warnings to alert you to this fact.  To silence these deprecation warnings,
70 install the modules in question from CPAN.
71
72 Note that these are (with rare exceptions) fine modules that you are encouraged
73 to continue to use.  Their disinclusion from core primarily hinges on their
74 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
75 not usually on concerns over their design.
76
77 =over
78
79 =item XXX
80
81 XXX Note that deprecated modules should be listed here even if they are listed
82 as an updated module in the L</Modules and Pragmata> section.
83
84 =back
85
86 [ List each other deprecation as a =head2 entry ]
87
88 =head1 Performance Enhancements
89
90 XXX Changes which enhance performance without changing behaviour go here.
91 There may well be none in a stable release.
92
93 [ List each enhancement as a =item entry ]
94
95 =over 4
96
97 =item *
98
99 XXX
100
101 =back
102
103 =head1 Modules and Pragmata
104
105 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
106 go here.  If Module::CoreList is updated, generate an initial draft of the
107 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
108 for important changes should then be added by hand.  In an ideal world,
109 dual-life modules would have a F<Changes> file that could be cribbed.
110
111 [ Within each section, list entries as a =item entry ]
112
113 =head2 New Modules and Pragmata
114
115 =over 4
116
117 =item *
118
119 XXX
120
121 =back
122
123 =head2 Updated Modules and Pragmata
124
125 =over 4
126
127 =item *
128
129 L<attributes> has been upgraded from version 0.26 to 0.27.
130
131 =item *
132
133 L<B> has been upgraded from version 1.57 to 1.58.
134
135 =item *
136
137 L<B::Deparse> has been upgraded from version 1.34 to 1.35.
138
139 C<< <<>> >> is now correctly deparsed.
140
141 =item *
142
143 L<Config::Perl::V> has been upgraded from version 0.23 to 0.24.
144
145 =item *
146
147 L<Cwd> has been upgraded from version 3.55 to 3.56.
148
149 =item *
150
151 L<ExtUtils::Miniperl> has been upgraded from version 1.04 to 1.05.
152
153 =item *
154
155 L<ExtUtils::ParseXS> has been upgraded from version 3.27 to 3.28.
156
157 =item *
158
159 L<ExtUtils::Typemaps> has been upgraded from version 3.25 to 3.28.
160
161 =item *
162
163 L<File::Spec> has been upgraded from version 3.55 to 3.56.
164
165 =item *
166
167 L<if> has been upgraded from version 0.0603 to 0.0604.
168
169 The documentation now notes that this module also works with C<no>.
170
171 =item *
172
173 L<IO::Socket::IP> has been upgraded from version 0.36 to 0.37.
174
175 =item *
176
177 L<Module::CoreList> has been upgraded from version 5.20150320 to 5.20150420.
178
179 Updated to cover the latest releases of Perl. Also fixes a fencepost error in
180 is_core() and copes with versions that do not match x.yyyzzz.
181
182 =item *
183
184 L<perl5db.pl> has been upgraded from 1.48 to 1.49.
185
186 The debugger would cause an assertion failure.  [perl #124127]
187
188 =item *
189
190 L<PerlIO::mmap> has been upgraded from version 0.013 to 0.014.
191
192 =item *
193
194 L<utf8> has been upgraded from version 1.15 to 1.16.
195
196 Minor documentation update only.
197
198 =item *
199
200 L<warnings> has been upgraded from version 1.31 to 1.32.
201
202 =back
203
204 =head2 Removed Modules and Pragmata
205
206 =over 4
207
208 =item *
209
210 XXX
211
212 =back
213
214 =head1 Documentation
215
216 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
217 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
218
219 =head2 New Documentation
220
221 XXX Changes which create B<new> files in F<pod/> go here.
222
223 =head3 L<XXX>
224
225 XXX Description of the purpose of the new file here
226
227 =head2 Changes to Existing Documentation
228
229 XXX Changes which significantly change existing files in F<pod/> go here.
230 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
231 section.
232
233 =head3 L<perlebcdic>
234
235 =over 4
236
237 =item *
238
239 This document has been significantly updated in the light of recent
240 improvements to EBCDIC support.
241
242 =back
243
244 =head3 L<perlfunc>
245
246 =over 4
247
248 =item *
249
250 Mention that C<study()> is currently a no-op.
251
252 =back
253
254 =head3 L<perlguts>
255
256 =over 4
257
258 =item *
259
260 The OOK example has been updated to account for COW changes and a change in the
261 storage of the offset.
262
263 =back
264
265 =head3 L<perlhacktips>
266
267 =over 4
268
269 =item *
270
271 Documentation has been added illustrating the perils of assuming the contents of
272 static memory pointed to by the return values of Perl wrappers for C library
273 functions doesn't change.
274
275 =back
276
277 =head3 L<perlport>
278
279 =over 4
280
281 =item *
282
283 Out-of-date VMS-specific information has been fixed/simplified.
284
285 =back
286
287 =head3 L<perluniintro>
288
289 =over 4
290
291 =item *
292
293 Advice for how to make sure your strings and regular expression patterns are
294 interpreted as Unicode has been revised to account for the new 5.22 EBCDIC
295 handling.
296
297 =back
298
299 =head3 L<perlvms>
300
301 =over 4
302
303 =item *
304
305 Out-of-date and/or incorrect material has been removed.
306
307 =back
308
309 =head1 Diagnostics
310
311 The following additions or changes have been made to diagnostic output,
312 including warnings and fatal error messages.  For the complete list of
313 diagnostic messages, see L<perldiag>.
314
315 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
316 include any changes in L<perldiag> that reconcile it to the C<C> code.
317
318 =head2 New Diagnostics
319
320 XXX Newly added diagnostic messages go under here, separated into New Errors
321 and New Warnings
322
323 =head3 New Errors
324
325 =over 4
326
327 =item *
328
329 XXX L<message|perldiag/"message">
330
331 =back
332
333 =head3 New Warnings
334
335 =over 4
336
337 =item *
338
339 XXX L<message|perldiag/"message">
340
341 =back
342
343 =head2 Changes to Existing Diagnostics
344
345 XXX Changes (i.e. rewording) of diagnostic messages go here
346
347 =over 4
348
349 =item *
350
351 XXX Describe change here
352
353 =back
354
355 =head1 Utility Changes
356
357 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
358 Most of these are built within the directory F<utils>.
359
360 [ List utility changes as a =head2 entry for each utility and =item
361 entries for each change
362 Use L<XXX> with program names to get proper documentation linking. ]
363
364 =head2 L<XXX>
365
366 =over 4
367
368 =item *
369
370 XXX
371
372 =back
373
374 =head1 Configuration and Compilation
375
376 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
377 go here.  Any other changes to the Perl build process should be listed here.
378 However, any platform-specific changes should be listed in the
379 L</Platform Support> section, instead.
380
381 [ List changes as a =item entry ].
382
383 =over 4
384
385 =item *
386
387 XXX
388
389 =back
390
391 =head1 Testing
392
393 XXX Any significant changes to the testing of a freshly built perl should be
394 listed here.  Changes which create B<new> files in F<t/> go here as do any
395 large changes to the testing harness (e.g. when parallel testing was added).
396 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
397 that they represent may be covered elsewhere.
398
399 [ List each test improvement as a =item entry ]
400
401 =over 4
402
403 =item *
404
405 F<t/porting/re_context.t> has been added to test that L<utf8> and its
406 dependencies only use the subset of the C<$1..$n> capture vars that
407 Perl_save_re_context() is hard-coded to localize, because that function has no
408 efficient way of determining at runtime what vars to localize.
409
410 =back
411
412 =head1 Platform Support
413
414 XXX Any changes to platform support should be listed in the sections below.
415
416 [ Within the sections, list each platform as a =item entry with specific
417 changes as paragraphs below it. ]
418
419 =head2 New Platforms
420
421 XXX List any platforms that this version of perl compiles on, that previous
422 versions did not.  These will either be enabled by new files in the F<hints/>
423 directories, or new subdirectories and F<README> files at the top level of the
424 source tree.
425
426 =over 4
427
428 =item XXX-some-platform
429
430 XXX
431
432 =back
433
434 =head2 Discontinued Platforms
435
436 XXX List any platforms that this version of perl no longer compiles on.
437
438 =over 4
439
440 =item XXX-some-platform
441
442 XXX
443
444 =back
445
446 =head2 Platform-Specific Notes
447
448 XXX List any changes for specific platforms.  This could include configuration
449 and compilation changes or changes in portability/compatibility.  However,
450 changes within modules for platforms should generally be listed in the
451 L</Modules and Pragmata> section.
452
453 =over 4
454
455 =item Win32
456
457 F<miniperl.exe> is now built with C<-fno-strict-aliasing>, allowing
458 64-bit builds to complete on GCC 4.8. [perl #123976]
459
460 C<test-prep> again depends on C<test-prep-gcc> for GCC builds. [perl
461 #124221]
462
463 =back
464
465 =head1 Internal Changes
466
467 =over 4
468
469 =item *
470
471 5.21.2 introduced a new build option, C<-DPERL_OP_PARENT>, which causes
472 the last C<op_sibling> pointer to refer back to the parent rather than
473 being C<NULL>, and where instead a new flag indicates the end of the
474 chain. In this release, the new implementation has been revised; in
475 particular:
476
477 =over 4
478
479 =item *
480
481 On C<PERL_OP_PARENT> builds, the C<op_sibling> field has been renamed
482 C<op_sibparent> to reflect its new dual purpose. Since the intention is that
483 this field should primarily be accessed via macros, this change should be
484 transparent for code written to work under C<PERL_OP_PARENT>.
485
486 =item *
487
488 The newly-introduced C<op_lastsib> flag bit has been renamed C<op_moresib>
489 and its logic inverted; i.e. it is initialised to zero in a new op, and is
490 changed to 1 when an op gains a sibling.
491
492 =item *
493
494 The function C<Perl_op_parent> is now only available on C<PERL_OP_PARENT>
495 builds. Using it on a plain build will be a compile-timer error.
496
497 =item *
498
499 Three new macros, C<OpMORESIB_set>, C<OpLASTSIB_set>, C<OpMAYBESIB_set>
500 have been added, which are intended to be be a low-level portable way to
501 set C<op_sibling> / C<op_sibparent> while also updating C<op_moresib>.
502 The first sets the sibling pointer to a new sibling, the second makes the
503 op the last sibling, and the third conditionally does the first or second
504 action. The C<op_sibling_splice()> function is retained as a higher-level
505 interface that can also maintain consistency in the parent at the same time
506 (e.g. by updating C<op_first> and C<op_last> where appropriate).
507
508 =item *
509
510 The macro C<OpSIBLING_set>, added in 5.21.2, has been removed. It didn't
511 manipulate C<op_moresib> and has been superseded by C<OpMORESIB_set> et
512 al.
513
514 =item *
515
516 The C<op_sibling_splice> function now accepts a null C<parent> argument
517 where the splicing doesn't affect the first or last ops in the sibling
518 chain, and thus where the parent doesn't need to be updated accordingly.
519
520 =back
521
522
523 =back
524
525 =head1 Selected Bug Fixes
526
527 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
528 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
529
530 [ List each fix as a =item entry ]
531
532 =over 4
533
534 =item *
535
536 C<pack("D", $x)> and C<pack("F", $x)> now zero the padding on x86 long
537 double builds.  GCC 4.8 and later, under some build options, would
538 either overwrite the zero-initialized padding, or bypass the
539 initialized buffer entirely.  This caused F<op/pack.t> to fail.  [perl
540 #123971]
541
542 =item *
543
544 Extending an array cloned from a parent thread could result in
545 "Modification of a read-only value attempted" errors when attempting
546 to modify the new elements. [perl #124127]
547
548 =item *
549
550 An assertion failure and subsequent crash with C<< *x=<y> >> has been fixed.
551 [perl #123790]
552
553 =item *
554
555 An optimization for state variable initialization introduced in Perl 5.21.6 has
556 been reverted because it was found to exacerbate some other existing buggy
557 behaviour. [perl #124160]
558
559 =item *
560
561 The extension of another optimization to cover more ops in Perl 5.21 has also
562 been reverted to its Perl 5.20 state as a temporary fix for regression issues
563 that it caused. [perl #123790]
564
565 =item *
566
567 New bitwise ops added in Perl 5.21.9 accidentally caused C<$^H |= 0x1c020000>
568 to enable all features.  This has now been fixed.
569
570 =item *
571
572 A possible crashing/looping bug has been fixed. [perl #124099]
573
574 =item *
575
576 UTF-8 variable names used in array indexes, unquoted UTF-8 HERE-document
577 terminators and UTF-8 function names all now work correctly. [perl #124113]
578
579 =item *
580
581 Breakage in C<require(VERSION)> (with parentheses), introduced in Perl 5.21.6,
582 has been fixed. [perl #124135]
583
584 =item *
585
586 Wide char warnings, wrongly raised in UTF-8 locales since Perl 5.21.8, are now
587 suppressed. [perl #123527]
588
589 =item *
590
591 A subtle bug introduced in Perl 5.21.4 involving UTF-8 in regular expressions
592 and sometimes causing a crash has been fixed. A new test script has been added
593 to test this fix; see under L</Testing>. [perl #124109]
594
595 =item *
596
597 A change introduced in Perl 5.21.10 that broke the autovivification CPAN module
598 has been reverted.
599
600 =item *
601
602 A bug whereby C<< 'FOO'->f() >> lost the read-only status of C<FOO>, introduced
603 in Perl 5.21.7, has been fixed. [perl #123619]
604
605 =item *
606
607 A regression in Perl 5.21 in the matching of C</[A-Z]/ai> has been fixed.
608
609 =back
610
611 =head1 Known Problems
612
613 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
614 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
615 platform specific bugs also go here.
616
617 [ List each fix as a =item entry ]
618
619 =over 4
620
621 =item *
622
623 XXX
624
625 =back
626
627 =head1 Errata From Previous Releases
628
629 =over 4
630
631 =item *
632
633 XXX Add anything here that we forgot to add, or were mistaken about, in
634 the perldelta of a previous release.
635
636 =back
637
638 =head1 Obituary
639
640 XXX If any significant core contributor has died, we've added a short obituary
641 here.
642
643 =head1 Acknowledgements
644
645 XXX Generate this with:
646
647   perl Porting/acknowledgements.pl v5.21.10..HEAD
648
649 =head1 Reporting Bugs
650
651 If you find what you think is a bug, you might check the articles recently
652 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
653 https://rt.perl.org/ .  There may also be information at
654 http://www.perl.org/ , the Perl Home Page.
655
656 If you believe you have an unreported bug, please run the L<perlbug> program
657 included with your release.  Be sure to trim your bug down to a tiny but
658 sufficient test case.  Your bug report, along with the output of C<perl -V>,
659 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
660
661 If the bug you are reporting has security implications, which make it
662 inappropriate to send to a publicly archived mailing list, then please send it
663 to perl5-security-report@perl.org.  This points to a closed subscription
664 unarchived mailing list, which includes all the core committers, who will be
665 able to help assess the impact of issues, figure out a resolution, and help
666 co-ordinate the release of patches to mitigate or fix the problem across all
667 platforms on which Perl is supported.  Please only use this address for
668 security issues in the Perl core, not for modules independently distributed on
669 CPAN.
670
671 =head1 SEE ALSO
672
673 The F<Changes> file for an explanation of how to view exhaustive details on
674 what changed.
675
676 The F<INSTALL> file for how to build Perl.
677
678 The F<README> file for general stuff.
679
680 The F<Artistic> and F<Copying> files for copyright information.
681
682 =cut