This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta: Give better instructions about (?^...)
[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 =head1 Security
57
58 XXX Any security-related notices go here.  In particular, any security
59 vulnerabilities closed should be noted here rather than in the
60 L</Selected Bug Fixes> section.
61
62 [ List each security issue as a =head2 entry ]
63
64 =head1 Incompatible Changes
65
66 =head2 Stringification of regexes has changed
67
68 Default regular expression modifiers are now notated by using
69 C<(?^...)>.  Code relying on the old stringification will fail.  The
70 purpose of this is so that when new modifiers are added, such code will
71 not have to change (after this one time), as the stringification will
72 automatically incorporate the new modifiers.
73
74 Code that needs to work properly with both old- and new-style regexes
75 can avoid the whole issue by using:
76
77  use re qw(regexp_pattern);
78  my ($pat, $mods) = regexp_pattern($re_ref);
79
80 where C<$re_ref> is a reference to a compiled regular expression.  Upon
81 return, C<$mods> will be a string containing all the non-default
82 modifiers used when the regular expression was compiled, and C<$pattern>
83 the actual pattern.
84
85 If the actual stringification is important, you can use something like
86 the following:
87
88     # Accept both old and new-style stringification
89     my $modifiers = (qr/foobar/ =~ /\Q(?^/) ? '^' : '-xism';
90
91 And then use C<$modifiers> instead of C<-xism>.
92
93 =head2 Regular expressions retain their localeness when interpolated
94
95 Regular expressions compiled under C<"use locale"> now retain this when
96 interpolated into a new regular expression compiled outside a
97 C<"use locale">, and vice-versa.
98
99 Previously, a regular expression interpolated into another one inherited
100 the localeness of the surrounding one, losing whatever state it
101 originally had.  This is considered a bug fix, but may trip up code that
102 has come to rely on the incorrect behavior.
103
104 [ List each incompatible change as a =head2 entry ]
105
106 =head1 Deprecations
107
108 XXX Any deprecated features, syntax, modules etc. should be listed here.
109 In particular, deprecated modules should be listed here even if they are
110 listed as an updated module in the L</Modules and Pragmata> section.
111
112 [ List each deprecation as a =head2 entry ]
113
114 =head1 Performance Enhancements
115
116 XXX Changes which enhance performance without changing behaviour go here. There
117 may well be none in a stable release.
118
119 [ List each enhancement as a =item entry ]
120
121 =over 4
122
123 =item *
124
125 XXX
126
127 =back
128
129 =head1 Modules and Pragmata
130
131 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
132 go here.  If Module::CoreList is updated, generate an initial draft of the
133 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
134 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
135 below.  A paragraph summary for important changes should then be added by hand.
136 In an ideal world, dual-life modules would have a F<Changes> file that could be
137 cribbed.
138
139 [ Within each section, list entries as a =item entry ]
140
141 =head2 New Modules and Pragmata
142
143 =over 4
144
145 =item *
146
147 XXX
148
149 =back
150
151 =head2 Updated Modules and Pragmata
152
153 =over 4
154
155 =item *
156
157 C<File::DosGlob> has been upgraded from version 1.02 to 1.03.
158
159 It allows patterns containing literal parentheses (they no longer need to
160 be escaped). On Windows, it no longer adds an extra F<./> to the file names
161 returned when the pattern is a relative glob with a drive specification,
162 like F<c:*.pl>.
163
164 =item *
165
166 C<File::Find> has been upgraded from version 1.17 to 1.18.
167
168 It improves handling of backslashes on Windows, so that paths such as
169 F<c:\dir\/file> are no longer generated.
170
171 =item *
172
173 C<NEXT> has been upgraded from version 0.64 to 0.65.
174
175 =item *
176
177 C<PathTools> has been upgraded from version 3.31_01 to 3.33.
178
179 =item *
180
181 C<Unicode::Collate> has been upgraded from version 0.59 to 0.60
182
183 =item *
184
185 C<Unicode::Normalize> has been upgraded from version 1.06 to 1.07
186
187 =back
188
189 =head2 Removed Modules and Pragmata
190
191 =over 4
192
193 =item *
194
195 XXX
196
197 =back
198
199 =head1 Documentation
200
201 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
202 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
203
204 =head2 New Documentation
205
206 XXX Changes which create B<new> files in F<pod/> go here.
207
208 =head3 L<XXX>
209
210 XXX Description of the purpose of the new file here
211
212 =head2 Changes to Existing Documentation
213
214 XXX Changes which significantly change existing files in F<pod/> go here.
215 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
216 section.
217
218 =head3 L<XXX>
219
220 =over 4
221
222 =item *
223
224 XXX Description of the change here
225
226 =back
227
228 =head1 Diagnostics
229
230 The following additions or changes have been made to diagnostic output,
231 including warnings and fatal error messages.  For the complete list of
232 diagnostic messages, see L<perldiag>.
233
234 XXX New or changed warnings emitted by the core's C<C> code go here. Also
235 include any changes in L<perldiag> that reconcile it to the C<C> code.
236
237 [ Within each section, list entries as a =item entry ]
238
239 =head2 New Diagnostics
240
241 XXX Newly added diagnostic messages go here
242
243 =over 4
244
245 =item *
246
247 XXX
248
249 =back
250
251 =head2 Changes to Existing Diagnostics
252
253 XXX Changes (i.e. rewording) of diagnostic messages go here
254
255 =over 4
256
257 =item *
258
259 XXX
260
261 =back
262
263 =head1 Utility Changes
264
265 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
266 here. Most of these are built within the directories F<utils> and F<x2p>.
267
268 [ List utility changes as a =head3 entry for each utility and =item
269 entries for each change
270 Use L<XXX> with program names to get proper documentation linking. ]
271
272 =head3 L<XXX>
273
274 =over 4
275
276 =item *
277
278 XXX
279
280 =back
281
282 =head1 Configuration and Compilation
283
284 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
285 go here.  Any other changes to the Perl build process should be listed here.
286 However, any platform-specific changes should be listed in the
287 L</Platform Support> section, instead.
288
289 [ List changes as a =item entry ].
290
291 =over 4
292
293 =item *
294
295 XXX
296
297 =back
298
299 =head1 Testing
300
301 XXX Any significant changes to the testing of a freshly built perl should be
302 listed here.  Changes which create B<new> files in F<t/> go here as do any
303 large changes to the testing harness (e.g. when parallel testing was added).
304 Changes to existing files in F<t/> aren't worth summarising, although the bugs
305 that they represent may be covered elsewhere.
306
307 [ List each test improvement as a =item entry ]
308
309 =over 4
310
311 =item *
312
313 XXX
314
315 =back
316
317 =head1 Platform Support
318
319 XXX Any changes to platform support should be listed in the sections below.
320
321 [ Within the sections, list each platform as a =item entry with specific
322 changes as paragraphs below it. ]
323
324 =head2 New Platforms
325
326 XXX List any platforms that this version of perl compiles on, that previous
327 versions did not. These will either be enabled by new files in the F<hints/>
328 directories, or new subdirectories and F<README> files at the top level of the
329 source tree.
330
331 =over 4
332
333 =item XXX-some-platform
334
335 XXX
336
337 =back
338
339 =head2 Discontinued Platforms
340
341 XXX List any platforms that this version of perl no longer compiles on.
342
343 =over 4
344
345 =item XXX-some-platform
346
347 XXX
348
349 =back
350
351 =head2 Platform-Specific Notes
352
353 XXX List any changes for specific platforms. This could include configuration
354 and compilation changes or changes in portability/compatibility.  However,
355 changes within modules for platforms should generally be listed in the
356 L</Modules and Pragmata> section.
357
358 =over 4
359
360 =item XXX-some-platform
361
362 XXX
363
364 =back
365
366 =head1 Internal Changes
367
368 XXX Changes which affect the interface available to C<XS> code go here.
369 Other significant internal changes for future core maintainers should
370 be noted as well.
371
372 [ List each test improvement as a =item entry ]
373
374 =over 4
375
376 =item *
377
378 See L</Regular expressions retain their localeness when interpolated>,
379 above.
380
381 =back
382
383 =head1 Selected Bug Fixes
384
385 XXX Important bug fixes in the core language are summarised here.
386 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
387 L</Modules and Pragmata>.
388
389 [ List each fix as a =item entry ]
390
391 =over 4
392
393 =item *
394
395 A regular expression match in the right-hand side of a global substitution
396 (C<s///g>) that is in the same scope will no longer cause match variables
397 to have the wrong values on subsequent iterations. This can happen when an
398 array or hash subscript is interpolated in the right-hand side, as in
399 C<s|(.)|@a{ print($1), /./ }|g>
400 L<[perl #19078]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=19078>.
401
402 =item *
403
404 Constant-folding used to cause
405
406   $text =~ ( 1 ? /phoo/ : /bear/)
407
408 to turn into
409
410   $text =~ /phoo/
411
412 at compile time. Now it correctly matches against C<$_>
413 L<[perl #20444]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=20444>.
414
415 =item *
416
417 Parsing Perl code (either with string C<eval> or by loading modules) from
418 within a C<UNITCHECK> block no longer causes the interpreter to crash
419 L<[perl #70614]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=70614>.
420
421 =item *
422
423 When C<-d> is used on the shebang (C<#!>) line, the debugger now has access
424 to the lines of the main program. In the past, this sometimes worked and
425 sometimes did not, depending on what order things happened to be arranged
426 in memory.
427
428 =back
429
430 =head1 Known Problems
431
432 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
433 tests that had to be C<TODO>ed for the release would be noted here, unless
434 they were specific to a particular platform (see below).
435
436 This is a list of some significant unfixed bugs, which are regressions
437 from either 5.XXX.XXX or 5.XXX.XXX.
438
439 [ List each fix as a =item entry ]
440
441 =over 4
442
443 =item *
444
445 XXX
446
447 =back
448
449 =head1 Obituary
450
451 XXX If any significant core contributor has died, we've added a short obituary
452 here.
453
454 =head1 Acknowledgements
455
456 XXX The list of people to thank goes here.
457
458 =head1 Reporting Bugs
459
460 If you find what you think is a bug, you might check the articles
461 recently posted to the comp.lang.perl.misc newsgroup and the perl
462 bug database at http://rt.perl.org/perlbug/ .  There may also be
463 information at http://www.perl.org/ , the Perl Home Page.
464
465 If you believe you have an unreported bug, please run the B<perlbug>
466 program included with your release.  Be sure to trim your bug down
467 to a tiny but sufficient test case.  Your bug report, along with the
468 output of C<perl -V>, will be sent off to perlbug@perl.org to be
469 analysed by the Perl porting team.
470
471 If the bug you are reporting has security implications, which make it
472 inappropriate to send to a publicly archived mailing list, then please send
473 it to perl5-security-report@perl.org. This points to a closed subscription
474 unarchived mailing list, which includes all the core committers, who be able
475 to help assess the impact of issues, figure out a resolution, and help
476 co-ordinate the release of patches to mitigate or fix the problem across all
477 platforms on which Perl is supported. Please only use this address for
478 security issues in the Perl core, not for modules independently
479 distributed on CPAN.
480
481 =head1 SEE ALSO
482
483 The F<Changes> file for an explanation of how to view exhaustive details
484 on what changed.
485
486 The F<INSTALL> file for how to build Perl.
487
488 The F<README> file for general stuff.
489
490 The F<Artistic> and F<Copying> files for copyright information.
491
492 =cut