This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
530a4900c2f76ddad21f3cfa2670edb8f3bfc75c
[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.15.0
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.15.0 release and
13 the 5.14.0 release.
14
15 If you are upgrading from an earlier release such as 5.YYY.YYY, first read
16 L<perl5YYYdelta>, which describes differences between 5.ZZZ.ZZZ and
17 5.YYY.YYY.
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 =head1 Security
32
33 XXX Any security-related notices go here.  In particular, any security
34 vulnerabilities closed should be noted here rather than in the
35 L</Selected Bug Fixes> section.
36
37 [ List each security issue as a =head2 entry ]
38
39 =head1 Incompatible Changes
40
41 [ List each incompatible change as a =head2 entry ]
42
43 =head1 Deprecations
44
45 XXX Any deprecated features, syntax, modules etc. should be listed here.
46 In particular, deprecated modules should be listed here even if they are
47 listed as an updated module in the L</Modules and Pragmata> section.
48
49 [ List each deprecation as a =head2 entry ]
50
51 =head1 Performance Enhancements
52
53 XXX Changes which enhance performance without changing behaviour go here. There
54 may well be none in a stable release.
55
56 [ List each enhancement as a =item entry ]
57
58 =over 4
59
60 =item *
61
62 XXX
63
64 =back
65
66 =head1 Modules and Pragmata
67
68 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
69 go here.  If Module::CoreList is updated, generate an initial draft of the
70 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
71 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
72 below.  A paragraph summary for important changes should then be added by hand.
73 In an ideal world, dual-life modules would have a F<Changes> file that could be
74 cribbed.
75
76 [ Within each section, list entries as a =item entry ]
77
78 =head2 New Modules and Pragmata
79
80 =over 4
81
82 =item *
83
84 XXX
85
86 =back
87
88 =head2 Updated Modules and Pragmata
89
90 =over 4
91
92 =item *
93
94 L<B> has been upgraded from version 1.29 to version 1.30.
95
96 =item *
97
98 L<Math::Complex> has been upgraded from version 1.56 to version 1.57.
99
100 Correct copy constructor usage.
101 Fix polarwise formatting with numeric format specifier.
102 More stable C<great_circle_direction> algorithm.
103
104 =item *
105
106 L<PerlIO::encoding> has been upgraded from version 0.14 to 0.15
107
108 =item *
109
110 L<Storable> has been upgraded from version 2.27 to version 2.28.
111
112 =item *
113
114 L<Time::HiRes> has been upgraded from version 1.9721_01 to version 1.9722.
115
116 Portability fix, and avoiding some compiler warnings.
117
118 =item *
119
120 XXX
121
122 =back
123
124 =head2 Removed Modules and Pragmata
125
126 =over 4
127
128 =item *
129
130 XXX
131
132 =back
133
134 =head1 Documentation
135
136 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
137 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
138
139 =head2 New Documentation
140
141 XXX Changes which create B<new> files in F<pod/> go here.
142
143 =head3 L<XXX>
144
145 XXX Description of the purpose of the new file here
146
147 =head2 Changes to Existing Documentation
148
149 XXX Changes which significantly change existing files in F<pod/> go here.
150 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
151 section.
152
153 =head3 L<XXX>
154
155 =over 4
156
157 =item *
158
159 XXX Description of the change here
160
161 =back
162
163 =head1 Diagnostics
164
165 The following additions or changes have been made to diagnostic output,
166 including warnings and fatal error messages.  For the complete list of
167 diagnostic messages, see L<perldiag>.
168
169 XXX New or changed warnings emitted by the core's C<C> code go here. Also
170 include any changes in L<perldiag> that reconcile it to the C<C> code.
171
172 [ Within each section, list entries as a =item entry ]
173
174 =head2 New Diagnostics
175
176 XXX Newly added diagnostic messages go here
177
178 =over 4
179
180 =item *
181
182 XXX
183
184 =back
185
186 =head2 Changes to Existing Diagnostics
187
188 XXX Changes (i.e. rewording) of diagnostic messages go here
189
190 =over 4
191
192 =item *
193
194 XXX
195
196 =back
197
198 =head1 Utility Changes
199
200 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
201 here. Most of these are built within the directories F<utils> and F<x2p>.
202
203 [ List utility changes as a =head3 entry for each utility and =item
204 entries for each change
205 Use L<XXX> with program names to get proper documentation linking. ]
206
207 =head3 L<XXX>
208
209 =over 4
210
211 =item *
212
213 XXX
214
215 =back
216
217 =head1 Configuration and Compilation
218
219 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
220 go here.  Any other changes to the Perl build process should be listed here.
221 However, any platform-specific changes should be listed in the
222 L</Platform Support> section, instead.
223
224 [ List changes as a =item entry ].
225
226 =over 4
227
228 =item *
229
230 XXX
231
232 =back
233
234 =head1 Testing
235
236 XXX Any significant changes to the testing of a freshly built perl should be
237 listed here.  Changes which create B<new> files in F<t/> go here as do any
238 large changes to the testing harness (e.g. when parallel testing was added).
239 Changes to existing files in F<t/> aren't worth summarising, although the bugs
240 that they represent may be covered elsewhere.
241
242 [ List each test improvement as a =item entry ]
243
244 =over 4
245
246 =item *
247
248 XXX
249
250 =back
251
252 =head1 Platform Support
253
254 XXX Any changes to platform support should be listed in the sections below.
255
256 [ Within the sections, list each platform as a =item entry with specific
257 changes as paragraphs below it. ]
258
259 =head2 New Platforms
260
261 XXX List any platforms that this version of perl compiles on, that previous
262 versions did not. These will either be enabled by new files in the F<hints/>
263 directories, or new subdirectories and F<README> files at the top level of the
264 source tree.
265
266 =over 4
267
268 =item XXX-some-platform
269
270 XXX
271
272 =back
273
274 =head2 Discontinued Platforms
275
276 XXX List any platforms that this version of perl no longer compiles on.
277
278 =over 4
279
280 =item XXX-some-platform
281
282 XXX
283
284 =back
285
286 =head2 Platform-Specific Notes
287
288 XXX List any changes for specific platforms. This could include configuration
289 and compilation changes or changes in portability/compatibility.  However,
290 changes within modules for platforms should generally be listed in the
291 L</Modules and Pragmata> section.
292
293 =over 4
294
295 =item XXX-some-platform
296
297 XXX
298
299 =back
300
301 =head1 Internal Changes
302
303 XXX Changes which affect the interface available to C<XS> code go here.
304 Other significant internal changes for future core maintainers should
305 be noted as well.
306
307 =over 4
308
309 =item *
310
311 The compiled representation of formats is now stored via the mg_ptr of
312 their PERL_MAGIC_fm. Previously it was stored in the string buffer,
313 beyond SvLEN(), the regular end of the string. SvCOMPILED() and
314 SvCOMPILED_{on,off}() now exist solely for compatibility for XS code.
315 The first is always 0, the other two now no-ops.
316
317 =back
318
319 =head1 Selected Bug Fixes
320
321 XXX Important bug fixes in the core language are summarised here.
322 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
323 L</Modules and Pragmata>.
324
325 [ List each fix as a =item entry ]
326
327 =over 4
328
329 =item *
330
331 The new (in 5.14.0) regular expression modifier C</a> when repeated like
332 C</aa> forbids the characters outside the ASCII range that match
333 characters inside that range from matching under C</i>.  This did not
334 work under some circumstances, all involving alternation, such as:
335
336  "\N{KELVIN SIGN}" =~ /k|foo/iaa;
337
338 succeeded inaprropriately.  This is now fixed.
339
340 =item *
341
342 5.14.0 introduced some memory leaks in regular expression character
343 classes such as C<[\w\s]>, which have now been fixed.
344
345 =item *
346
347 An edge case in regular expression matching could potentially loop.
348 This happened only under C</i> in bracketed character classes that have
349 characters with multi-character folds, and the target string to match
350 against includes the first portion of the fold, followed by another
351 character that has a multi-character fold that begins with the remaining
352 portion of the fold, plus some more.
353
354  "s\N{U+DF}" =~ /[\x{DF}foo]/i
355
356 is one such case.  C<\xDF> folds to C<"ss">
357
358 =item *
359
360 A few characters in regular expression pattern matches did not
361 match correctly in some circumstances, all involving C</i>.  The
362 affected characters are:
363 COMBINING GREEK YPOGEGRAMMENI,
364 GREEK CAPITAL LETTER IOTA,
365 GREEK CAPITAL LETTER UPSILON,
366 GREEK PROSGEGRAMMENI,
367 GREEK SMALL LETTER IOTA WITH DIALYTIKA AND OXIA,
368 GREEK SMALL LETTER IOTA WITH DIALYTIKA AND TONOS,
369 GREEK SMALL LETTER UPSILON WITH DIALYTIKA AND OXIA,
370 GREEK SMALL LETTER UPSILON WITH DIALYTIKA AND TONOS,
371 LATIN SMALL LETTER LONG S,
372 LATIN SMALL LIGATURE LONG S T,
373 and
374 LATIN SMALL LIGATURE ST.
375
376 =item *
377
378 Formats: number of edge cases have been fixed with formats and formline;
379 in particular, where the format itself is potentially variable (such as
380 with ties and overloading), and where the format and data differ in their
381 encoding. In both these cases, it used to possible for the output to be
382 corrupted.
383
384 =back
385
386 =head1 Known Problems
387
388 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
389 tests that had to be C<TODO>ed for the release would be noted here, unless
390 they were specific to a particular platform (see below).
391
392 This is a list of some significant unfixed bugs, which are regressions
393 from either 5.XXX.XXX or 5.XXX.XXX.
394
395 [ List each fix as a =item entry ]
396
397 =over 4
398
399 =item *
400
401 XXX
402
403 =back
404
405 =head1 Obituary
406
407 XXX If any significant core contributor has died, we've added a short obituary
408 here.
409
410 =head1 Acknowledgements
411
412 XXX The list of people to thank goes here.
413
414 =head1 Reporting Bugs
415
416 If you find what you think is a bug, you might check the articles
417 recently posted to the comp.lang.perl.misc newsgroup and the perl
418 bug database at http://rt.perl.org/perlbug/ .  There may also be
419 information at http://www.perl.org/ , the Perl Home Page.
420
421 If you believe you have an unreported bug, please run the L<perlbug>
422 program included with your release.  Be sure to trim your bug down
423 to a tiny but sufficient test case.  Your bug report, along with the
424 output of C<perl -V>, will be sent off to perlbug@perl.org to be
425 analysed by the Perl porting team.
426
427 If the bug you are reporting has security implications, which make it
428 inappropriate to send to a publicly archived mailing list, then please send
429 it to perl5-security-report@perl.org. This points to a closed subscription
430 unarchived mailing list, which includes all the core committers, who be able
431 to help assess the impact of issues, figure out a resolution, and help
432 co-ordinate the release of patches to mitigate or fix the problem across all
433 platforms on which Perl is supported. Please only use this address for
434 security issues in the Perl core, not for modules independently
435 distributed on CPAN.
436
437 =head1 SEE ALSO
438
439 The F<Changes> file for an explanation of how to view exhaustive details
440 on what changed.
441
442 The F<INSTALL> file for how to build Perl.
443
444 The F<README> file for general stuff.
445
446 The F<Artistic> and F<Copying> files for copyright information.
447
448 =cut