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