This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Correct pod syntax in perldelta
[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
6 XXX needs to be processed before release. ]
7
8 perldelta - what is new for perl v5.13.6
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.13.5 release and
13 the 5.13.6 release.
14
15 If you are upgrading from an earlier release such as 5.13.4, first read
16 L<perl5135delta>, which describes differences between 5.13.4 and
17 5.13.5.
18
19 =head1 Notice
20
21 XXX Any important notices here
22
23 =head1 Core Enhancements
24
25 XXX New core language features go here. Summarise user-visible core language
26 enhancements. Particularly prominent performance optimisations could go
27 here, but most should go in the L</Performance Enhancements> section.
28
29 [ List each enhancement as a =head2 entry ]
30
31 =head2  C<(?^...)> regex construct added to signify default modifiers
32
33 A caret (also called a "cirumflex accent") C<"^"> immediately following
34 a C<"(?"> in a regular expression now means that the subexpression is to
35 not inherit the surrounding modifiers such as C</i>, but to revert to the
36 Perl defaults.  Any modifiers following the caret override the defaults.
37
38 The stringification of regular expressions now uses this notation.  The
39 main purpose of this is to allow tests that rely on the stringification
40 to not have to change when new modifiers are added.  See
41 L<perlre/Extended Patterns>.
42
43 =head2 C<"d">, C<"l">, and C<"u"> regex modifiers added
44
45 These modifiers are currently only available within a C<(?...)> construct.
46
47 The C<"l"> modifier says to compile the regular expression as if it were
48 in the scope of C<use locale>, even if it is not.
49
50 The C<"u"> modifier currently does nothing.
51
52 The C<"d"> modifier is used in the scope of C<use locale> to compile the
53 regular expression as if it were not in that scope.
54 See L<perlre/(?dlupimsx-imsx)>.
55
56 =head2 C<\N{...}> now handles Unicode named character sequences
57
58 Unicode has a number of named character sequences, in which particular sequences
59 of code points are given names.  C<\N{...}> now recognizes these.
60 See L<charnames>.
61
62 =head2 New function C<charnames::string_vianame()>
63
64 This function is a run-time version of C<\N{...}>, returning the string
65 of characters whose Unicode name is its parameter.  It can handle
66 Unicode named character sequences, whereas the pre-existing
67 C<charnames::vianame()> cannot, as the latter returns a single code
68 point.
69 See L<charnames>.
70
71 =head1 Security
72
73 XXX Any security-related notices go here.  In particular, any security
74 vulnerabilities closed should be noted here rather than in the
75 L</Selected Bug Fixes> section.
76
77 [ List each security issue as a =head2 entry ]
78
79 =head1 Incompatible Changes
80
81 =head2 Stringification of regexes has changed
82
83 Default regular expression modifiers are now notated by using
84 C<(?^...)>.  Code relying on the old stringification will fail.  The
85 purpose of this is so that when new modifiers are added, such code will
86 not have to change (after this one time), as the stringification will
87 automatically incorporate the new modifiers.
88
89 Code that needs to work properly with both old- and new-style regexes
90 can avoid the whole issue by using (for Perls since 5.9.5):
91
92  use re qw(regexp_pattern);
93  my ($pat, $mods) = regexp_pattern($re_ref);
94
95 where C<$re_ref> is a reference to a compiled regular expression.  Upon
96 return, C<$mods> will be a string containing all the non-default
97 modifiers used when the regular expression was compiled, and C<$pattern>
98 the actual pattern.
99
100 If the actual stringification is important, or older Perls need to be
101 supported, you can use something like the following:
102
103     # Accept both old and new-style stringification
104     my $modifiers = (qr/foobar/ =~ /\Q(?^/) ? '^' : '-xism';
105
106 And then use C<$modifiers> instead of C<-xism>.
107
108 =head2 Regular expressions retain their localeness when interpolated
109
110 Regular expressions compiled under C<"use locale"> now retain this when
111 interpolated into a new regular expression compiled outside a
112 C<"use locale">, and vice-versa.
113
114 Previously, a regular expression interpolated into another one inherited
115 the localeness of the surrounding one, losing whatever state it
116 originally had.  This is considered a bug fix, but may trip up code that
117 has come to rely on the incorrect behavior.
118
119 [ List each incompatible change as a =head2 entry ]
120
121 =head1 Deprecations
122
123 XXX Any deprecated features, syntax, modules etc. should be listed here.
124 In particular, deprecated modules should be listed here even if they are
125 listed as an updated module in the L</Modules and Pragmata> section.
126
127 [ List each deprecation as a =head2 entry ]
128
129 =head1 Performance Enhancements
130
131 XXX Changes which enhance performance without changing behaviour go here. There
132 may well be none in a stable release.
133
134 [ List each enhancement as a =item entry ]
135
136 =over 4
137
138 =item *
139
140 XXX
141
142 =back
143
144 =head1 Modules and Pragmata
145
146 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
147 go here.  If Module::CoreList is updated, generate an initial draft of the
148 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
149 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
150 below.  A paragraph summary for important changes should then be added by hand.
151 In an ideal world, dual-life modules would have a F<Changes> file that could be
152 cribbed.
153
154 [ Within each section, list entries as a =item entry ]
155
156 =head2 New Modules and Pragmata
157
158 =over 4
159
160 =item *
161
162 XXX
163
164 =back
165
166 =head2 Updated Modules and Pragmata
167
168 =over 4
169
170 =item *
171
172 C<Carp> has been upgraded from version 1.18 to 1.19.
173
174 It no longer autovivifies the C<*CORE::GLOBAL::caller> glob, something it
175 started doing in 1.18, which was released with perl 5.13.4
176 L<[perl #78082]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=78082>
177
178 =item *
179
180 C<Data::Dumper> has been upgraded from version 2.128 to 2.129.
181
182 C<Dumpxs> no longer crashes with globs returned by C<*$io_ref>
183 L<[perl #72332]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=72332>.
184
185 =item *
186
187 C<Digest::MD5> has been upgraded from version 2.40 to 2.50.
188
189 It is now safe to use this module in combination with threads.
190
191 =item *
192
193 C<File::DosGlob> has been upgraded from version 1.02 to 1.03.
194
195 It allows patterns containing literal parentheses (they no longer need to
196 be escaped). On Windows, it no longer adds an extra F<./> to the file names
197 returned when the pattern is a relative glob with a drive specification,
198 like F<c:*.pl>
199 L<[perl #71712]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=71712>.
200
201 =item *
202
203 C<File::Find> has been upgraded from version 1.17 to 1.18.
204
205 It improves handling of backslashes on Windows, so that paths such as
206 F<c:\dir\/file> are no longer generated
207 L<[perl #71710]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=71710>.
208
209 =item *
210
211 C<if> has been upgraded from version 0.05 to 0.06
212
213 =item *
214
215 C<IPC::Open3> has been upgraded from version 1.06 to 1.07.
216
217 The internal C<xclose> routine now knows how to handle file descriptors, as
218 documented, so duplicating STDIN in a child process using its file
219 descriptor now works
220 L<[perl #76474]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=71710>.
221
222 =item *
223
224 C<Locale::Maketext> has been upgraded from version 1.15 to 1.16.
225
226 It fixes an infinite loop in C<Locale::Maketext::Guts::_compile()> when
227 working with tainted values
228 (L<CPAN RT #40727|https://rt.cpan.org/Public/Bug/Display.html?id=40727>).
229
230 =item *
231
232 C<NEXT> has been upgraded from version 0.64 to 0.65.
233
234 =item *
235
236 C<PathTools> has been upgraded from version 3.31_01 to 3.33.
237
238 =item *
239
240 C<sigtrap> has been upgraded from version 1.04 to 1.05.
241
242 It no longer tries to modify read-only arguments when generating a
243 backtrace
244 L<[perl #72340]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=72340>.
245
246 =item *
247
248 C<Unicode::Collate> has been upgraded from version 0.59 to 0.60
249
250 =item *
251
252 C<Unicode::Normalize> has been upgraded from version 1.06 to 1.07
253
254 =back
255
256 =head2 Removed Modules and Pragmata
257
258 =over 4
259
260 =item *
261
262 XXX
263
264 =back
265
266 =head1 Documentation
267
268 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
269 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
270
271 =head2 New Documentation
272
273 XXX Changes which create B<new> files in F<pod/> go here.
274
275 =head3 L<XXX>
276
277 XXX Description of the purpose of the new file here
278
279 =head2 Changes to Existing Documentation
280
281 XXX Changes which significantly change existing files in F<pod/> go here.
282 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
283 section.
284
285 =head3 L<XXX>
286
287 =over 4
288
289 =item *
290
291 The documentation for the C<SvTRUE> macro was simply wrong in stating that
292 get-magic is not processed. It has been corrected.
293
294 =back
295
296 =head1 Diagnostics
297
298 The following additions or changes have been made to diagnostic output,
299 including warnings and fatal error messages.  For the complete list of
300 diagnostic messages, see L<perldiag>.
301
302 XXX New or changed warnings emitted by the core's C<C> code go here. Also
303 include any changes in L<perldiag> that reconcile it to the C<C> code.
304
305 [ Within each section, list entries as a =item entry ]
306
307 =head2 New Diagnostics
308
309 XXX Newly added diagnostic messages go here
310
311 =over 4
312
313 =item *
314
315 XXX
316
317 =back
318
319 =head2 Changes to Existing Diagnostics
320
321 XXX Changes (i.e. rewording) of diagnostic messages go here
322
323 =over 4
324
325 =item *
326
327 The 'Layer does not match this perl' error message has been replaced with
328 these more helpful messages:
329
330 =over 4
331
332 =item *
333
334 PerlIO layer function table size (%d) does not match size expected by this
335 perl (%d)
336
337 =item *
338
339 PerlIO layer instance size (%d) does not match size expected by this perl
340 (%d)
341
342 =back
343
344 L<[perl #73754]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=73754>
345
346 =back
347
348 =head1 Utility Changes
349
350 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
351 here. Most of these are built within the directories F<utils> and F<x2p>.
352
353 [ List utility changes as a =head3 entry for each utility and =item
354 entries for each change
355 Use L<XXX> with program names to get proper documentation linking. ]
356
357 =head3 L<XXX>
358
359 =over 4
360
361 =item *
362
363 XXX
364
365 =back
366
367 =head1 Configuration and Compilation
368
369 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
370 go here.  Any other changes to the Perl build process should be listed here.
371 However, any platform-specific changes should be listed in the
372 L</Platform Support> section, instead.
373
374 [ List changes as a =item entry ].
375
376 =over 4
377
378 =item *
379
380 XXX
381
382 =back
383
384 =head1 Testing
385
386 XXX Any significant changes to the testing of a freshly built perl should be
387 listed here.  Changes which create B<new> files in F<t/> go here as do any
388 large changes to the testing harness (e.g. when parallel testing was added).
389 Changes to existing files in F<t/> aren't worth summarising, although the bugs
390 that they represent may be covered elsewhere.
391
392 [ List each test improvement as a =item entry ]
393
394 =over 4
395
396 =item *
397
398 XXX
399
400 =back
401
402 =head1 Platform Support
403
404 XXX Any changes to platform support should be listed in the sections below.
405
406 [ Within the sections, list each platform as a =item entry with specific
407 changes as paragraphs below it. ]
408
409 =head2 New Platforms
410
411 XXX List any platforms that this version of perl compiles on, that previous
412 versions did not. These will either be enabled by new files in the F<hints/>
413 directories, or new subdirectories and F<README> files at the top level of the
414 source tree.
415
416 =over 4
417
418 =item XXX-some-platform
419
420 XXX
421
422 =back
423
424 =head2 Discontinued Platforms
425
426 XXX List any platforms that this version of perl no longer compiles on.
427
428 =over 4
429
430 =item XXX-some-platform
431
432 XXX
433
434 =back
435
436 =head2 Platform-Specific Notes
437
438 XXX List any changes for specific platforms. This could include configuration
439 and compilation changes or changes in portability/compatibility.  However,
440 changes within modules for platforms should generally be listed in the
441 L</Modules and Pragmata> section.
442
443 =over 4
444
445 =item Windows
446
447 C<$Config{gccversion}> is now set correctly when perl is built using the
448 mingw64 compiler from L<http://mingw64.org>
449 L<[perl #73754]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=73754>.
450
451 =back
452
453 =head1 Internal Changes
454
455 XXX Changes which affect the interface available to C<XS> code go here.
456 Other significant internal changes for future core maintainers should
457 be noted as well.
458
459 [ List each test improvement as a =item entry ]
460
461 =over 4
462
463 =item *
464
465 See L</Regular expressions retain their localeness when interpolated>,
466 above.
467
468 =item *
469
470 The C<sv_cmp_flags>, C<sv_cmp_locale_flags>, C<sv_eq_flags> and
471 C<sv_collxfrm_flags> functions have been added. These are like their
472 non-_flags counterparts, but allow one to specify whether get-magic is
473 processed.
474
475 The C<sv_cmp>, C<sv_cmp_locale>, C<sv_eq> and C<sv_collxfrm> functions have
476 been replaced with wrappers around the new functions. 
477
478 =item *
479
480 A new C<sv_2bool_flags> function has been added.
481
482 This is like C<sv_2bool>, but it lets the calling code decide whether
483 get-magic is handled. C<sv_2bool> is now a macro that calls the new
484 function.
485
486 =item *
487
488 A new macro, C<SvTRUE_nomg>, has been added.
489
490 This is like C<SvTRUE>, except that it does not process magic. It uses the
491 new C<sv_2bool_flags> function.
492
493 =item *
494
495 C<sv_catsv_flags> no longer calls C<mg_get> on its second argument (the
496 source string) if the flags passed to it do not include SV_GMAGIC. So it
497 now matches what the documentation says it does.
498
499 =back
500
501 =head1 Selected Bug Fixes
502
503 XXX Important bug fixes in the core language are summarised here.
504 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
505 L</Modules and Pragmata>.
506
507 [ List each fix as a =item entry ]
508
509 =over 4
510
511 =item *
512
513 A regular expression match in the right-hand side of a global substitution
514 (C<s///g>) that is in the same scope will no longer cause match variables
515 to have the wrong values on subsequent iterations. This can happen when an
516 array or hash subscript is interpolated in the right-hand side, as in
517 C<s|(.)|@a{ print($1), /./ }|g>
518 L<[perl #19078]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=19078>.
519
520 =item *
521
522 Constant-folding used to cause
523
524   $text =~ ( 1 ? /phoo/ : /bear/)
525
526 to turn into
527
528   $text =~ /phoo/
529
530 at compile time. Now it correctly matches against C<$_>
531 L<[perl #20444]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=20444>.
532
533 =item *
534
535 Parsing Perl code (either with string C<eval> or by loading modules) from
536 within a C<UNITCHECK> block no longer causes the interpreter to crash
537 L<[perl #70614]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=70614>.
538
539 =item *
540
541 When C<-d> is used on the shebang (C<#!>) line, the debugger now has access
542 to the lines of the main program. In the past, this sometimes worked and
543 sometimes did not, depending on what order things happened to be arranged
544 in memory
545 L<[perl #71806]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=71806>.
546
547 =item *
548
549 The C<y///> or C<tr///> operator now calls get-magic (e.g., the C<FETCH>
550 method of a tie) on its left-hand side just once, not twice
551 L<[perl #76814]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=76814>.
552
553 =item *
554
555 String comparison (C<eq>, C<ne>, C<lt>, C<gt>, C<le>, C<ge> and
556 C<cmp>) and logical not (C<not> and C<!>) operators no longer call magic
557 (e.g., tie methods) twice on their operands
558 L<[perl #76814]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=76814>.
559
560 This bug was introduced in an earlier 5.13 release, and does not affect
561 perl 5.12.
562
563 =item *
564
565 When a tied (or other magic) variable is used as, or in, a regular
566 expression, it no longer has its C<FETCH> method called twice
567 L<[perl #76814]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=76814>.
568
569 This bug was introduced in an earlier 5.13 release, and does not affect
570 perl 5.12.
571
572 =item *
573
574 The C<-C> command line option can now be followed by other options
575 L<[perl #72434]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=72434>.
576
577 =item *
578
579 Assigning a glob to a PVLV used to convert it to a plain string. Now it
580 works correctly, and a PVLV can hold a glob. This would happen when a
581 nonexistent hash or array element was passed to a subroutine:
582
583   sub { $_[0] = *foo }->($hash{key});
584   # $_[0] would have been the string "*main::foo"
585
586 It also happened when a glob was assigned to, or returned from, an element
587 of a tied array or hash
588 L<[perl #36051]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=36051>.
589
590 =back
591
592 =head1 Known Problems
593
594 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
595 tests that had to be C<TODO>ed for the release would be noted here, unless
596 they were specific to a particular platform (see below).
597
598 This is a list of some significant unfixed bugs, which are regressions
599 from either 5.XXX.XXX or 5.XXX.XXX.
600
601 [ List each fix as a =item entry ]
602
603 =over 4
604
605 =item *
606
607 XXX
608
609 =back
610
611 =head1 Obituary
612
613 XXX If any significant core contributor has died, we've added a short obituary
614 here.
615
616 =head1 Errata
617
618 =over 4
619
620 =item *
621
622 Fixed a typo in L<perl5135delta> regarding array slices and smart matching
623
624 =back
625
626 =head1 Acknowledgements
627
628 XXX The list of people to thank goes here.
629
630 =head1 Reporting Bugs
631
632 If you find what you think is a bug, you might check the articles
633 recently posted to the comp.lang.perl.misc newsgroup and the perl
634 bug database at http://rt.perl.org/perlbug/ .  There may also be
635 information at http://www.perl.org/ , the Perl Home Page.
636
637 If you believe you have an unreported bug, please run the B<perlbug>
638 program included with your release.  Be sure to trim your bug down
639 to a tiny but sufficient test case.  Your bug report, along with the
640 output of C<perl -V>, will be sent off to perlbug@perl.org to be
641 analysed by the Perl porting team.
642
643 If the bug you are reporting has security implications, which make it
644 inappropriate to send to a publicly archived mailing list, then please send
645 it to perl5-security-report@perl.org. This points to a closed subscription
646 unarchived mailing list, which includes all the core committers, who be able
647 to help assess the impact of issues, figure out a resolution, and help
648 co-ordinate the release of patches to mitigate or fix the problem across all
649 platforms on which Perl is supported. Please only use this address for
650 security issues in the Perl core, not for modules independently
651 distributed on CPAN.
652
653 =head1 SEE ALSO
654
655 The F<Changes> file for an explanation of how to view exhaustive details
656 on what changed.
657
658 The F<INSTALL> file for how to build Perl.
659
660 The F<README> file for general stuff.
661
662 The F<Artistic> and F<Copying> files for copyright information.
663
664 =cut