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