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