This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
8bd549bee67bc9e77b5cc9600dd869dfc733bb0d
[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<Digest::MD5> has been upgraded from version 2.40 to 2.50.
173
174 It is now safe to use this module in combination with threads.
175
176 =item *
177
178 C<File::DosGlob> has been upgraded from version 1.02 to 1.03.
179
180 It allows patterns containing literal parentheses (they no longer need to
181 be escaped). On Windows, it no longer adds an extra F<./> to the file names
182 returned when the pattern is a relative glob with a drive specification,
183 like F<c:*.pl>
184 L<[perl #71712]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=71712>.
185
186 =item *
187
188 C<File::Find> has been upgraded from version 1.17 to 1.18.
189
190 It improves handling of backslashes on Windows, so that paths such as
191 F<c:\dir\/file> are no longer generated
192 L<[perl #71710]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=71710>.
193
194 =item *
195
196 C<Locale::Maketext> has been upgraded from version 1.15 to 1.16.
197
198 It fixes an infinite loop in C<Locale::Maketext::Guts::_compile()> when
199 working with tainted values
200 (L<CPAN RT #40727|https://rt.cpan.org/Public/Bug/Display.html?id=40727>).
201
202 =item *
203
204 C<NEXT> has been upgraded from version 0.64 to 0.65.
205
206 =item *
207
208 C<PathTools> has been upgraded from version 3.31_01 to 3.33.
209
210 =item *
211
212 C<sigtrap> has been upgraded from version 1.04 to 1.05.
213
214 It no longer tries to modify read-only arguments when generating a
215 backtrace
216 L<[perl #72340]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=72340>.
217
218 =item *
219
220 C<Unicode::Collate> has been upgraded from version 0.59 to 0.60
221
222 =item *
223
224 C<Unicode::Normalize> has been upgraded from version 1.06 to 1.07
225
226 =back
227
228 =head2 Removed Modules and Pragmata
229
230 =over 4
231
232 =item *
233
234 XXX
235
236 =back
237
238 =head1 Documentation
239
240 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
241 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
242
243 =head2 New Documentation
244
245 XXX Changes which create B<new> files in F<pod/> go here.
246
247 =head3 L<XXX>
248
249 XXX Description of the purpose of the new file here
250
251 =head2 Changes to Existing Documentation
252
253 XXX Changes which significantly change existing files in F<pod/> go here.
254 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
255 section.
256
257 =head3 L<XXX>
258
259 =over 4
260
261 =item *
262
263 The documentation for the C<SvTRUE> macro was simply wrong in stating that
264 get-magic is not processed. It has been corrected.
265
266 =back
267
268 =head1 Diagnostics
269
270 The following additions or changes have been made to diagnostic output,
271 including warnings and fatal error messages.  For the complete list of
272 diagnostic messages, see L<perldiag>.
273
274 XXX New or changed warnings emitted by the core's C<C> code go here. Also
275 include any changes in L<perldiag> that reconcile it to the C<C> code.
276
277 [ Within each section, list entries as a =item entry ]
278
279 =head2 New Diagnostics
280
281 XXX Newly added diagnostic messages go here
282
283 =over 4
284
285 =item *
286
287 XXX
288
289 =back
290
291 =head2 Changes to Existing Diagnostics
292
293 XXX Changes (i.e. rewording) of diagnostic messages go here
294
295 =over 4
296
297 =item *
298
299 XXX
300
301 =back
302
303 =head1 Utility Changes
304
305 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
306 here. Most of these are built within the directories F<utils> and F<x2p>.
307
308 [ List utility changes as a =head3 entry for each utility and =item
309 entries for each change
310 Use L<XXX> with program names to get proper documentation linking. ]
311
312 =head3 L<XXX>
313
314 =over 4
315
316 =item *
317
318 XXX
319
320 =back
321
322 =head1 Configuration and Compilation
323
324 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
325 go here.  Any other changes to the Perl build process should be listed here.
326 However, any platform-specific changes should be listed in the
327 L</Platform Support> section, instead.
328
329 [ List changes as a =item entry ].
330
331 =over 4
332
333 =item *
334
335 XXX
336
337 =back
338
339 =head1 Testing
340
341 XXX Any significant changes to the testing of a freshly built perl should be
342 listed here.  Changes which create B<new> files in F<t/> go here as do any
343 large changes to the testing harness (e.g. when parallel testing was added).
344 Changes to existing files in F<t/> aren't worth summarising, although the bugs
345 that they represent may be covered elsewhere.
346
347 [ List each test improvement as a =item entry ]
348
349 =over 4
350
351 =item *
352
353 XXX
354
355 =back
356
357 =head1 Platform Support
358
359 XXX Any changes to platform support should be listed in the sections below.
360
361 [ Within the sections, list each platform as a =item entry with specific
362 changes as paragraphs below it. ]
363
364 =head2 New Platforms
365
366 XXX List any platforms that this version of perl compiles on, that previous
367 versions did not. These will either be enabled by new files in the F<hints/>
368 directories, or new subdirectories and F<README> files at the top level of the
369 source tree.
370
371 =over 4
372
373 =item XXX-some-platform
374
375 XXX
376
377 =back
378
379 =head2 Discontinued Platforms
380
381 XXX List any platforms that this version of perl no longer compiles on.
382
383 =over 4
384
385 =item XXX-some-platform
386
387 XXX
388
389 =back
390
391 =head2 Platform-Specific Notes
392
393 XXX List any changes for specific platforms. This could include configuration
394 and compilation changes or changes in portability/compatibility.  However,
395 changes within modules for platforms should generally be listed in the
396 L</Modules and Pragmata> section.
397
398 =over 4
399
400 =item XXX-some-platform
401
402 XXX
403
404 =back
405
406 =head1 Internal Changes
407
408 XXX Changes which affect the interface available to C<XS> code go here.
409 Other significant internal changes for future core maintainers should
410 be noted as well.
411
412 [ List each test improvement as a =item entry ]
413
414 =over 4
415
416 =item *
417
418 See L</Regular expressions retain their localeness when interpolated>,
419 above.
420
421 =item *
422
423 The C<sv_cmp_flags>, C<sv_cmp_locale_flags>, C<sv_eq_flags> and
424 C<sv_collxfrm_flags> functions have been added. These are like their
425 non-_flags counterparts, but allow one to specify whether get-magic is
426 processed.
427
428 The C<sv_cmp>, C<sv_cmp_locale>, C<sv_eq> and C<sv_collxfrm> functions have
429 been replaced with wrappers around the new functions. 
430
431 =item *
432
433 A new C<sv_2bool_flags> function has been added.
434
435 This is like C<sv_2bool>, but it lets the calling code decide whether
436 get-magic is handled. C<sv_2bool> is now a macro that calls the new
437 function.
438
439 =item *
440
441 A new macro, C<SvTRUE_nomg>, has been added.
442
443 This is like C<SvTRUE>, except that it does not process magic. It uses the
444 new C<sv_2bool_flags> function.
445
446 =item *
447
448 C<sv_catsv_flags> no longer calls C<mg_get> on its second argument (the
449 source string) if the flags passed to it do not include SV_GMAGIC. So it
450 now matches what the documentation says it does.
451
452 =back
453
454 =head1 Selected Bug Fixes
455
456 XXX Important bug fixes in the core language are summarised here.
457 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
458 L</Modules and Pragmata>.
459
460 [ List each fix as a =item entry ]
461
462 =over 4
463
464 =item *
465
466 A regular expression match in the right-hand side of a global substitution
467 (C<s///g>) that is in the same scope will no longer cause match variables
468 to have the wrong values on subsequent iterations. This can happen when an
469 array or hash subscript is interpolated in the right-hand side, as in
470 C<s|(.)|@a{ print($1), /./ }|g>
471 L<[perl #19078]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=19078>.
472
473 =item *
474
475 Constant-folding used to cause
476
477   $text =~ ( 1 ? /phoo/ : /bear/)
478
479 to turn into
480
481   $text =~ /phoo/
482
483 at compile time. Now it correctly matches against C<$_>
484 L<[perl #20444]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=20444>.
485
486 =item *
487
488 Parsing Perl code (either with string C<eval> or by loading modules) from
489 within a C<UNITCHECK> block no longer causes the interpreter to crash
490 L<[perl #70614]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=70614>.
491
492 =item *
493
494 When C<-d> is used on the shebang (C<#!>) line, the debugger now has access
495 to the lines of the main program. In the past, this sometimes worked and
496 sometimes did not, depending on what order things happened to be arranged
497 in memory
498 L<[perl #71806]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=71806>.
499
500 =item *
501
502 The C<y///> or C<tr///> operator now calls get-magic (e.g., the C<FETCH>
503 method of a tie) on its left-hand side just once, not twice
504 L<[perl #76814]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=76814>.
505
506 =item *
507
508 String comparison (C<eq>, C<ne>, C<lt>, C<gt>, C<le>, C<ge> and
509 C<cmp>) and logical not (C<not> and C<!>) operators no longer call magic
510 (e.g., tie methods) twice on their operands
511 L<[perl #76814]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=76814>.
512
513 This bug was introduced in an earlier 5.13 release, and does not affect
514 perl 5.12.
515
516 =item *
517
518 When a tied (or other magic) variable is used as, or in, a regular
519 expression, it no longer has its C<FETCH> method called twice
520 L<[perl #76814]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=76814>.
521
522 This bug was introduced in an earlier 5.13 release, and does not affect
523 perl 5.12.
524
525 =back
526
527 =head1 Known Problems
528
529 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
530 tests that had to be C<TODO>ed for the release would be noted here, unless
531 they were specific to a particular platform (see below).
532
533 This is a list of some significant unfixed bugs, which are regressions
534 from either 5.XXX.XXX or 5.XXX.XXX.
535
536 [ List each fix as a =item entry ]
537
538 =over 4
539
540 =item *
541
542 XXX
543
544 =back
545
546 =head1 Obituary
547
548 XXX If any significant core contributor has died, we've added a short obituary
549 here.
550
551 =head1 Errata
552
553 =over 4
554
555 =item *
556
557 Fixed a typo in L<perl5135delta> regarding array slices and smart matching
558
559 =back
560
561 =head1 Acknowledgements
562
563 XXX The list of people to thank goes here.
564
565 =head1 Reporting Bugs
566
567 If you find what you think is a bug, you might check the articles
568 recently posted to the comp.lang.perl.misc newsgroup and the perl
569 bug database at http://rt.perl.org/perlbug/ .  There may also be
570 information at http://www.perl.org/ , the Perl Home Page.
571
572 If you believe you have an unreported bug, please run the B<perlbug>
573 program included with your release.  Be sure to trim your bug down
574 to a tiny but sufficient test case.  Your bug report, along with the
575 output of C<perl -V>, will be sent off to perlbug@perl.org to be
576 analysed by the Perl porting team.
577
578 If the bug you are reporting has security implications, which make it
579 inappropriate to send to a publicly archived mailing list, then please send
580 it to perl5-security-report@perl.org. This points to a closed subscription
581 unarchived mailing list, which includes all the core committers, who be able
582 to help assess the impact of issues, figure out a resolution, and help
583 co-ordinate the release of patches to mitigate or fix the problem across all
584 platforms on which Perl is supported. Please only use this address for
585 security issues in the Perl core, not for modules independently
586 distributed on CPAN.
587
588 =head1 SEE ALSO
589
590 The F<Changes> file for an explanation of how to view exhaustive details
591 on what changed.
592
593 The F<INSTALL> file for how to build Perl.
594
595 The F<README> file for general stuff.
596
597 The F<Artistic> and F<Copying> files for copyright information.
598
599 =cut