This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update Module::CoreList for 5.12.4
[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 L<Module::CoreList> has been upgraded from version 2.49 to 2.50.
121
122 Updated for v5.12.4.
123
124 =item *
125
126 XXX
127
128 =back
129
130 =head2 Removed Modules and Pragmata
131
132 =over 4
133
134 =item *
135
136 XXX
137
138 =back
139
140 =head1 Documentation
141
142 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
143 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
144
145 =head2 New Documentation
146
147 XXX Changes which create B<new> files in F<pod/> go here.
148
149 =head3 L<XXX>
150
151 XXX Description of the purpose of the new file here
152
153 =head2 Changes to Existing Documentation
154
155 XXX Changes which significantly change existing files in F<pod/> go here.
156 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
157 section.
158
159 =head3 L<XXX>
160
161 =over 4
162
163 =item *
164
165 XXX Description of the change here
166
167 =back
168
169 =head1 Diagnostics
170
171 The following additions or changes have been made to diagnostic output,
172 including warnings and fatal error messages.  For the complete list of
173 diagnostic messages, see L<perldiag>.
174
175 XXX New or changed warnings emitted by the core's C<C> code go here. Also
176 include any changes in L<perldiag> that reconcile it to the C<C> code.
177
178 [ Within each section, list entries as a =item entry ]
179
180 =head2 New Diagnostics
181
182 XXX Newly added diagnostic messages go here
183
184 =over 4
185
186 =item *
187
188 XXX
189
190 =back
191
192 =head2 Changes to Existing Diagnostics
193
194 XXX Changes (i.e. rewording) of diagnostic messages go here
195
196 =over 4
197
198 =item *
199
200 XXX
201
202 =back
203
204 =head1 Utility Changes
205
206 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
207 here. Most of these are built within the directories F<utils> and F<x2p>.
208
209 [ List utility changes as a =head3 entry for each utility and =item
210 entries for each change
211 Use L<XXX> with program names to get proper documentation linking. ]
212
213 =head3 L<XXX>
214
215 =over 4
216
217 =item *
218
219 XXX
220
221 =back
222
223 =head1 Configuration and Compilation
224
225 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
226 go here.  Any other changes to the Perl build process should be listed here.
227 However, any platform-specific changes should be listed in the
228 L</Platform Support> section, instead.
229
230 [ List changes as a =item entry ].
231
232 =over 4
233
234 =item *
235
236 XXX
237
238 =back
239
240 =head1 Testing
241
242 XXX Any significant changes to the testing of a freshly built perl should be
243 listed here.  Changes which create B<new> files in F<t/> go here as do any
244 large changes to the testing harness (e.g. when parallel testing was added).
245 Changes to existing files in F<t/> aren't worth summarising, although the bugs
246 that they represent may be covered elsewhere.
247
248 [ List each test improvement as a =item entry ]
249
250 =over 4
251
252 =item *
253
254 XXX
255
256 =back
257
258 =head1 Platform Support
259
260 XXX Any changes to platform support should be listed in the sections below.
261
262 [ Within the sections, list each platform as a =item entry with specific
263 changes as paragraphs below it. ]
264
265 =head2 New Platforms
266
267 XXX List any platforms that this version of perl compiles on, that previous
268 versions did not. These will either be enabled by new files in the F<hints/>
269 directories, or new subdirectories and F<README> files at the top level of the
270 source tree.
271
272 =over 4
273
274 =item XXX-some-platform
275
276 XXX
277
278 =back
279
280 =head2 Discontinued Platforms
281
282 XXX List any platforms that this version of perl no longer compiles on.
283
284 =over 4
285
286 =item XXX-some-platform
287
288 XXX
289
290 =back
291
292 =head2 Platform-Specific Notes
293
294 XXX List any changes for specific platforms. This could include configuration
295 and compilation changes or changes in portability/compatibility.  However,
296 changes within modules for platforms should generally be listed in the
297 L</Modules and Pragmata> section.
298
299 =over 4
300
301 =item XXX-some-platform
302
303 XXX
304
305 =back
306
307 =head1 Internal Changes
308
309 XXX Changes which affect the interface available to C<XS> code go here.
310 Other significant internal changes for future core maintainers should
311 be noted as well.
312
313 =over 4
314
315 =item *
316
317 The compiled representation of formats is now stored via the mg_ptr of
318 their PERL_MAGIC_fm. Previously it was stored in the string buffer,
319 beyond SvLEN(), the regular end of the string. SvCOMPILED() and
320 SvCOMPILED_{on,off}() now exist solely for compatibility for XS code.
321 The first is always 0, the other two now no-ops.
322
323 =back
324
325 =head1 Selected Bug Fixes
326
327 XXX Important bug fixes in the core language are summarised here.
328 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
329 L</Modules and Pragmata>.
330
331 [ List each fix as a =item entry ]
332
333 =over 4
334
335 =item *
336
337 The new (in 5.14.0) regular expression modifier C</a> when repeated like
338 C</aa> forbids the characters outside the ASCII range that match
339 characters inside that range from matching under C</i>.  This did not
340 work under some circumstances, all involving alternation, such as:
341
342  "\N{KELVIN SIGN}" =~ /k|foo/iaa;
343
344 succeeded inaprropriately.  This is now fixed.
345
346 =item *
347
348 5.14.0 introduced some memory leaks in regular expression character
349 classes such as C<[\w\s]>, which have now been fixed.
350
351 =item *
352
353 An edge case in regular expression matching could potentially loop.
354 This happened only under C</i> in bracketed character classes that have
355 characters with multi-character folds, and the target string to match
356 against includes the first portion of the fold, followed by another
357 character that has a multi-character fold that begins with the remaining
358 portion of the fold, plus some more.
359
360  "s\N{U+DF}" =~ /[\x{DF}foo]/i
361
362 is one such case.  C<\xDF> folds to C<"ss">
363
364 =item *
365
366 A few characters in regular expression pattern matches did not
367 match correctly in some circumstances, all involving C</i>.  The
368 affected characters are:
369 COMBINING GREEK YPOGEGRAMMENI,
370 GREEK CAPITAL LETTER IOTA,
371 GREEK CAPITAL LETTER UPSILON,
372 GREEK PROSGEGRAMMENI,
373 GREEK SMALL LETTER IOTA WITH DIALYTIKA AND OXIA,
374 GREEK SMALL LETTER IOTA WITH DIALYTIKA AND TONOS,
375 GREEK SMALL LETTER UPSILON WITH DIALYTIKA AND OXIA,
376 GREEK SMALL LETTER UPSILON WITH DIALYTIKA AND TONOS,
377 LATIN SMALL LETTER LONG S,
378 LATIN SMALL LIGATURE LONG S T,
379 and
380 LATIN SMALL LIGATURE ST.
381
382 =item *
383
384 Formats: number of edge cases have been fixed with formats and formline;
385 in particular, where the format itself is potentially variable (such as
386 with ties and overloading), and where the format and data differ in their
387 encoding. In both these cases, it used to possible for the output to be
388 corrupted.
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 L<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