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