This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
507d5eecc95034fa26de033a3389d2da1347437b
[perl5.git] / pod / perldelta.pod
1 =encoding utf8
2
3 =for release_engineer
4 * changelogged up to a1bbdff
5 * the mauve module will not be part of the release, so it's not changelogged
6 yet. it also added some new api functions. those aren't covered either, as they
7 might go away again in case mauve gets rolled back for 5.13.5.
8
9 =head1 NAME
10
11 [ this is a template for a new perldelta file. Any text flagged as
12 XXX needs to be processed before release. ]
13
14 perldelta - what is new for perl v5.13.5
15
16 =head1 DESCRIPTION
17
18 This document describes differences between the 5.13.4 release and
19 the 5.13.5 release.
20
21 If you are upgrading from an earlier release such as 5.13.3, first read
22 L<perl5134delta>, which describes differences between 5.13.3 and
23 5.13.4.
24
25 =head1 Notice
26
27 XXX Any important notices here
28
29 =head1 Core Enhancements
30
31 XXX New core language features go here. Summarise user-visible core language
32 enhancements. Particularly prominent performance optimisations could go
33 here, but most should go in the L</Performance Enhancements> section.
34
35 =head2 Adjacent pairs of nextstate opcodes are now optimized away
36
37 Previously, in code such as
38
39     use constant DEBUG => 0;
40
41     sub GAK {
42         warn if DEBUG;
43         print "stuff\n";
44     }
45
46 the ops for C<warn if DEBUG;> would be folded to a C<null> op (C<ex-const>), but
47 the C<nextstate> op would remain, resulting in a runtime op dispatch of
48 C<nextstate>, C<nextstate>, ...
49
50 The execution of a sequence of C<nexstate> ops is indistinguishable from just
51 the last C<nextstate> op, so teach the peephole optimiser to eliminate the first
52 of a pair of C<nextstate> ops. (Except where the first carries a label, as
53 labels mustn't be eliminated by the optimiser, and label usage isn't
54 conclusively known at compile time.)
55
56 =head2 API function to parse statements
57
58 The C<parse_fullstmt> function has been added to allow parsing of a single
59 complete Perl statement. See L<perlapi> for details.
60
61 =head2 API functions for accessing the runtime hinthash
62
63 A new C API for introspecting the hinthash C<%^H> at runtime has been added. See
64 C<cop_hints_2hv>, C<cop_hints_fetchpvn>, C<cop_hints_fetchpvs>, and
65 C<cop_hints_fetchsv> in L<perlapi> for details.
66
67 =head2 C interface to C<caller()>
68
69 The C<caller_cx> function has been added as an XSUB-writer's equivalent of
70 C<caller()>. See L<perlapi> for details.
71
72 =head1 Security
73
74 XXX Any security-related notices go here.  In particular, any security
75 vulnerabilities closed should be noted here rather than in the
76 L</Selected Bug Fixes> section.
77
78 [ List each security issue as a =head2 entry ]
79
80 =head1 Incompatible Changes
81
82 =head2 Magic Variables Outside the Main Package
83
84 In previous versions of perl, magic variables like C<$!>, C<%SIG>, etc.  would
85 'leak' into other packages. So C<%foo::SIG> could be used to access signals,
86 C<${"foo::!"}> (with strict mode off) to access C's C<errno>, etc.
87
88 This was a bug, or an 'unintentional' feature, which caused various ill
89 effects, such as signal handlers being wiped when modules were loaded, etc.
90
91 This has been fixed (or the feature has been removed, depending on how you
92 see it).
93
94 =head2 Smart-matching against array slices
95
96 Previously, the following code resulted in a successful match:
97
98     my @a = qw(a y0 z);
99     my @b = qw(a x0 z);
100     $a[0 .. $#b] ~~ @b;
101
102 This odd behaviour has now been fixed [perl #77468].
103
104 =head2 C API changes
105
106 The first argument of the C API function C<Perl_fetch_cop_label> has changed
107 from C<struct refcounted he *> to C<COP *>, to better insulate the user from
108 implementation details.
109
110 This API function was marked as "may change", and likely isn't in use outside
111 the core. (Neither an unpacked CPAN, nor Google's codesearch, finds any other
112 references to it.)
113
114 =head1 Deprecations
115
116 XXX Any deprecated features, syntax, modules etc. should be listed here.
117 In particular, deprecated modules should be listed here even if they are
118 listed as an updated module in the L</Modules and Pragmata> section.
119
120 =head2 Use of qw(...) as parentheses
121
122 Historically the parser fooled itself into thinking that C<qw(...)> literals
123 were always enclosed in parentheses, and as a result you could sometimes omit
124 parentheses around them:
125
126     for $x qw(a b c) { ... }
127
128 The parser no longer lies to itself in this way.  Wrap the list literal in
129 parentheses, like:
130
131     for $x (qw(a b c)) { ... }
132
133 =head1 Performance Enhancements
134
135 XXX Changes which enhance performance without changing behaviour go here. There
136 may well be none in a stable release.
137
138 [ List each enhancement as a =item entry ]
139
140 =over 4
141
142 =item *
143
144 Scalars containing regular expressions now only allocate the part of the C<SV>
145 body they actually use, saving some space.
146
147 =item *
148
149 Compiling regular expressions has been made faster for the case where upgrading
150 the regex to utf8 is necessary, but that isn't known when the compilation
151 begins.
152
153 =back
154
155 =head1 Modules and Pragmata
156
157 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
158 go here.  If Module::CoreList is updated, generate an initial draft of the
159 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
160 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
161 below.  A paragraph summary for important changes should then be added by hand.
162 In an ideal world, dual-life modules would have a F<Changes> file that could be
163 cribbed.
164
165 [ Within each section, list entries as a =item entry ]
166
167 =head2 New Modules and Pragmata
168
169 =over 4
170
171 =item *
172
173 XXX
174
175 =back
176
177 =head2 Updated Modules and Pragmata
178
179 =over 4
180
181 =item *
182
183 C<blib> has been upgraded from version 1.05 to 1.06.
184
185 =item *
186
187 C<bignum>, C<bigint>, and C<bigrat> have been upgraded from version 0.23 to
188 0.24.
189
190 =item *
191
192 C<open> has been upgraded from version 1.07 to 1.08.
193
194 =item *
195
196 C<warnings> has been upgraded from version 1.10 to 1.11.
197
198 C<warnings::register> has been upgraded from version 1.01 to 1.02.
199
200 It is now possible to register warning categories other than the names of
201 packages using warnings::register.  See L<perllexwarn> for more information.
202
203 =item *
204
205 C<B::Debug> has been upgraded from version 1.12 to 1.14.
206
207 =item *
208
209 C<Data::Dumper> has been upgraded from version 2.126 to 2.128.
210
211 This fixes a crash when using custom sort functions that might cause the stack
212 to change.
213
214 =item *
215
216 C<Errno> has been upgraded from version 1.12 to 1.13.
217
218 On some platforms with unusual header files, like Win32/gcc using mingw64
219 headers, some constants which weren't actually error numbers have been exposed
220 by C<Errno>. This has been fixed (RT#77416).
221
222 =item *
223
224 C<ExtUtils::MakeMaker> has been upgraded from version 6.56 to 6.57_05.
225
226 =item *
227
228 C<Filter::Simple> has been upgraded from version 0.84 to 0.85.
229
230 =item *
231
232 C<Math::BigInt> has been upgraded from version 1.89_01 to 1.95.
233 C<Math::BigInt::Calc> has been upgraded from version 0.52 to 0.54.
234
235 This fixes, among other things, incorrect results when computing binomial
236 coefficients (RT#77640).
237
238 =item *
239
240 C<Math::BigInt::FastCalc> has been upgraded from version 0.19 to 0.22.
241
242 =item *
243
244 C<Math::BigRat> has been upgraded from version 0.24 to 0.25.
245
246 =item *
247
248 C<Module::CoreList> has been upgraded from version 2.37 to 2.38.
249
250 =item *
251
252 C<POSIX> has been upgraded from version 1.19 to 1.20.
253
254 It now includes constants for POSIX signal constants.
255
256 =item *
257
258 C<Safe> has been upgraded from version 2.27 to 2.28.
259
260 This fixes a possible infinite loop when looking for coderefs.
261
262 =item *
263
264 C<Tie::Hash> has been upgraded from version 1.03 to 1.04.
265
266 Calling C<< Tie::Hash->TIEHASH() >> used to loop forever. Now it C<croak>s.
267
268 =item *
269
270 C<Unicode::Collate> has been upgraded from version 0.56 to 0.59.
271
272 =item *
273
274 C<XSLoader> has been upgraded from version 0.10 to 0.11.
275
276 =back
277
278 =head2 Removed Modules and Pragmata
279
280 =over 4
281
282 =item *
283
284 XXX
285
286 =back
287
288 =head1 Documentation
289
290 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
291 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
292
293 =head2 New Documentation
294
295 XXX Changes which create B<new> files in F<pod/> go here.
296
297 =head3 L<XXX>
298
299 XXX Description of the purpose of the new file here
300
301 =head2 Changes to Existing Documentation
302
303 XXX Changes which significantly change existing files in F<pod/> go here.
304 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
305 section.
306
307 =head3 L<perlapi>
308
309 =over 4
310
311 =item *
312
313 Many of the optree construction functions are now documented.
314
315 =back
316
317 =head3 L<perlfaq>
318
319 L<perlfaq>, L<perlfaq2>, L<perlfaq4>, L<perlfaq5>, L<perlfaq6>, L<perlfaq8>, and
320 L<perlfaq9> have seen various updates and modernisations.
321
322 =head1 Diagnostics
323
324 The following additions or changes have been made to diagnostic output,
325 including warnings and fatal error messages.  For the complete list of
326 diagnostic messages, see L<perldiag>.
327
328 XXX New or changed warnings emitted by the core's C<C> code go here. Also
329 include any changes in L<perldiag> that reconcile it to the C<C> code.
330
331 [ Within each section, list entries as a =item entry ]
332
333 =head2 New Diagnostics
334
335 XXX Newly added diagnostic messages go here
336
337 =over 4
338
339 =item *
340
341 Use of qw(...) as parentheses is deprecated
342
343 =back
344
345 =head2 Changes to Existing Diagnostics
346
347 XXX Changes (i.e. rewording) of diagnostic messages go here
348
349 =over 4
350
351 =item *
352
353 XXX
354
355 =back
356
357 =head1 Utility Changes
358
359 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
360 here. Most of these are built within the directories F<utils> and F<x2p>.
361
362 [ List utility changes as a =head3 entry for each utility and =item
363 entries for each change
364 Use L<XXX> with program names to get proper documentation linking. ]
365
366 =head3 L<h2ph>
367
368 =over 4
369
370 =item *
371
372 The use of a deprecated C<goto> construct has been removed (RT#74404).
373
374 =back
375
376 =head1 Configuration and Compilation
377
378 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
379 go here.  Any other changes to the Perl build process should be listed here.
380 However, any platform-specific changes should be listed in the
381 L</Platform Support> section, instead.
382
383 [ List changes as a =item entry ].
384
385 =over 4
386
387 =item *
388
389 XXX
390
391 =back
392
393 =head1 Testing
394
395 XXX Any significant changes to the testing of a freshly built perl should be
396 listed here.  Changes which create B<new> files in F<t/> go here as do any
397 large changes to the testing harness (e.g. when parallel testing was added).
398 Changes to existing files in F<t/> aren't worth summarising, although the bugs
399 that they represent may be covered elsewhere.
400
401 [ List each test improvement as a =item entry ]
402
403 =over 4
404
405 =item *
406
407 A rare race condition in F<t/op/while_readdir.t> has been fixed, stopping it
408 from failing randomly when running tests in parallel.
409
410 =item *
411
412 The new F<t/op/leaky-magic.t> script tests that magic applied to variables in
413 the main packages does not affect other packages.
414
415 =back
416
417 =head1 Platform Support
418
419 XXX Any changes to platform support should be listed in the sections below.
420
421 [ Within the sections, list each platform as a =item entry with specific
422 changes as paragraphs below it. ]
423
424 =head2 New Platforms
425
426 XXX List any platforms that this version of perl compiles on, that previous
427 versions did not. These will either be enabled by new files in the F<hints/>
428 directories, or new subdirectories and F<README> files at the top level of the
429 source tree.
430
431 =over 4
432
433 =item XXX-some-platform
434
435 XXX
436
437 =back
438
439 =head2 Discontinued Platforms
440
441 XXX List any platforms that this version of perl no longer compiles on.
442
443 =over 4
444
445 =item XXX-some-platform
446
447 XXX
448
449 =back
450
451 =head2 Platform-Specific Notes
452
453 XXX List any changes for specific platforms. This could include configuration
454 and compilation changes or changes in portability/compatibility.  However,
455 changes within modules for platforms should generally be listed in the
456 L</Modules and Pragmata> section.
457
458 =over 4
459
460 =item VMS
461
462 =over 4
463
464 =item *
465
466 Make PerlIOUnix_open honor default permissions on VMS.
467
468 When perlio became the default and unixio became the default bottom layer, the
469 most common path for creating files from Perl became C<PerlIOUnix_open>, which
470 has always explicitly used C<0666> as the permission mask.
471
472 To avoid this, C<0777> is now passed as the permissions to C<open()>. In the VMS
473 CRTL, C<0777> has a special meaning over and above intersecting with the current
474 umask; specifically, it allows Unix syscalls to preserve native default
475 permissions.
476
477 =back
478
479 =back
480
481 =head1 Internal Changes
482
483 XXX Changes which affect the interface available to C<XS> code go here.
484 Other significant internal changes for future core maintainers should
485 be noted as well.
486
487 [ List each test improvement as a =item entry ]
488
489 =over 4
490
491 =item *
492
493 C<CALL_FPTR> and C<CPERLscope> have been removed deprecated.
494
495 Those are left from an old implementation of C<MULTIPLICITY> using C++ objects,
496 which has been removed in 5.8. Nowadays these macros do exactly nothing, so they
497 shouldn't be used anymore.
498
499 For compatibility, they are still defined for external C<XS> code. Only
500 extensions defining C<PERL_CORE> must be updated now.
501
502 =item *
503
504 C<lex_stuff_pvs()> has been added as a convenience macro wrapping
505 C<lex_stuff_pvn()> for literal strings.
506
507 =item *
508
509 The recursive part of the peephole optimizer is how hookable.
510
511 In addition to C<PL_peepp>, for hooking into the toplevel peephole optimizer, a
512 C<PL_rpeepp> is now available to hook into the optimizer recursing into
513 side-chains of the optree.
514
515 =back
516
517 =head1 Selected Bug Fixes
518
519 XXX Important bug fixes in the core language are summarised here.
520 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
521 L</Modules and Pragmata>.
522
523 [ List each fix as a =item entry ]
524
525 =over 4
526
527 =item *
528
529 A regression introduced in perl 5.12.0, making
530 C<< my $x = 3; $x = length(undef) >> result in C<$x> set to C<3> has been
531 fixed. C<$x> will now be C<undef>.
532
533 =item *
534
535 A fatal error in regular expressions when processing UTF-8 data has been fixed
536 (RT#75680).
537
538 =item *
539
540 An erroneous regular expression engine optimization, that caused regex verbs
541 like C<*COMMIT> to sometimes be ignored, has been removed.
542
543 =item *
544
545 The perl debugger now also works in taint mode (RT#76872).
546
547 =item *
548
549 Several memory leaks in cloning and freeing threaded perl interpreters have been
550 fixed (RT#77352).
551
552 =item *
553
554 A possible string corruption when doing regular expression matches on overloaded
555 objects has been fixed (RT#77084).
556
557 =item *
558
559 Magic applied to variables in the main package no longer affects other
560 packages. See L</Magic Variables Outside the Main Package>, above [perl #76138].
561
562 =item *
563
564 Opening a glob reference via C<< open $fh, ">", \*glob >> will no longer cause
565 the glob to be corrupted when the file handle is printed to. This would cause
566 perl to crash whenever the glob's contents were accessed [perl #77492].
567
568 =item *
569
570 The postincrement and postdecrement operators, C<++> and C<--> used to cause
571 leaks when being used on references. This has now been fixed.
572
573 =item *
574
575 A bug when replacing the glob of a loop variable within the loop has been
576 fixed [perl #21469]. This means the following code will no longer crash:
577
578     for $x (...) {
579         *x = *y;
580     }
581
582 =item *
583
584 Perl would segfault if the undocumented C<Internals> functions that
585 used reference prototypes were called with the C<&foo()> syntax,
586 e.g. C<&Internals::SvREADONLY(undef)> [perl #77776].
587
588 These functions now call C<SvROK> on their arguments before
589 dereferencing them with C<SvRV>, and we test for this case in
590 F<t/lib/universal.t>.
591
592 =item *
593
594 When assigning a list with duplicated keys to a hash, the assignment used to
595 return garbage and/or freed values:
596
597    @a = %h = (list with some duplicate keys);
598
599 This has now been fixed [perl #31865].
600
601 =item *
602
603 An earlier release of the 5.13 series of perl changed the semantics of opening a
604 reference to a copy of a glob:
605
606     my $var = *STDOUT;
607     open my $fh, '>', \$var;
608
609 This was a mistake, and the previous behaviour from perl 5.10 and 5.12, which is
610 to treat \$var as a scalar reference, has now been restored.
611
612 =back
613
614 =head1 Known Problems
615
616 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
617 tests that had to be C<TODO>ed for the release would be noted here, unless
618 they were specific to a particular platform (see below).
619
620 This is a list of some significant unfixed bugs, which are regressions
621 from either 5.XXX.XXX or 5.XXX.XXX.
622
623 [ List each fix as a =item entry ]
624
625 =over 4
626
627 =item *
628
629 XXX
630
631 =back
632
633 =head1 Obituary
634
635 XXX If any significant core contributor has died, we've added a short obituary
636 here.
637
638 =head1 Acknowledgements
639
640 XXX The list of people to thank goes here.
641
642 =head1 Reporting Bugs
643
644 If you find what you think is a bug, you might check the articles
645 recently posted to the comp.lang.perl.misc newsgroup and the perl
646 bug database at http://rt.perl.org/perlbug/ .  There may also be
647 information at http://www.perl.org/ , the Perl Home Page.
648
649 If you believe you have an unreported bug, please run the B<perlbug>
650 program included with your release.  Be sure to trim your bug down
651 to a tiny but sufficient test case.  Your bug report, along with the
652 output of C<perl -V>, will be sent off to perlbug@perl.org to be
653 analysed by the Perl porting team.
654
655 If the bug you are reporting has security implications, which make it
656 inappropriate to send to a publicly archived mailing list, then please send
657 it to perl5-security-report@perl.org. This points to a closed subscription
658 unarchived mailing list, which includes all the core committers, who be able
659 to help assess the impact of issues, figure out a resolution, and help
660 co-ordinate the release of patches to mitigate or fix the problem across all
661 platforms on which Perl is supported. Please only use this address for
662 security issues in the Perl core, not for modules independently
663 distributed on CPAN.
664
665 =head1 SEE ALSO
666
667 The F<Changes> file for an explanation of how to view exhaustive details
668 on what changed.
669
670 The F<INSTALL> file for how to build Perl.
671
672 The F<README> file for general stuff.
673
674 The F<Artistic> and F<Copying> files for copyright information.
675
676 =cut