This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
6ab99d01ee7e6afac4fcad6f580a25d0aa6c3633
[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.2
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.15.1 release and
13 the 5.15.2 release.
14
15 If you are upgrading from an earlier release such as 5.15.0, first read
16 L<perl5151delta>, which describes differences between 5.15.0 and
17 5.15.1.
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 XXX For a release on a stable branch, this section aspires to be:
42
43     There are no changes intentionally incompatible with 5.XXX.XXX
44     If any exist, they are bugs and reports are welcome.
45
46 [ List each incompatible change as a =head2 entry ]
47
48 =head2 C<UNIVERSAL::VERSION> now returns $VERSION
49
50 C<UNIVERSAL::VERSION> now return whatever is in $VERSION, instead of
51 returning $VERSION converted to a version object and then to a string.
52 As a result, it no longer parses the version when called without arguments,
53 so it no longer dies in that case for malformed versions.  This allows
54 custom version number parsers to use C<< ->VERSION >> to retrieve the
55 version number, as was the case in Perl 5.8 [perl #95544].
56
57 =head1 Deprecations
58
59 XXX Any deprecated features, syntax, modules etc. should be listed here.
60 In particular, deprecated modules should be listed here even if they are
61 listed as an updated module in the L</Modules and Pragmata> section.
62
63 [ List each deprecation as a =head2 entry ]
64
65 =head1 Performance Enhancements
66
67 XXX Changes which enhance performance without changing behaviour go here. There
68 may well be none in a stable release.
69
70 [ List each enhancement as a =item entry ]
71
72 =over 4
73
74 =item *
75
76 XXX
77
78 =back
79
80 =head1 Modules and Pragmata
81
82 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
83 go here.  If Module::CoreList is updated, generate an initial draft of the
84 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
85 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
86 below.  A paragraph summary for important changes should then be added by hand.
87 In an ideal world, dual-life modules would have a F<Changes> file that could be
88 cribbed.
89
90 [ Within each section, list entries as a =item entry ]
91
92 =head2 New Modules and Pragmata
93
94 =over 4
95
96 =item *
97
98 XXX
99
100 =back
101
102 =head2 Updated Modules and Pragmata
103
104 =over 4
105
106 =item *
107
108 L<CPANPLUS> has been upgraded from version 0.9108 to version 0.9109
109
110 Fixed support for v-strings and x.y.z versions with v5.8.4
111
112 =item *
113
114 L<CPAN::Meta> has been upgraded from version 2.110930_001 to version 2.112150
115
116 Stringify any objects encountered during conversion.
117
118 Clarified that file paths in the 'provides' section must be in
119 Unix-style (i.e. forward slashes)
120
121 =item *
122
123 L<ExtUtils::Install> has been upgraded from version 1.56 to version 1.57.
124
125 There is no change to ExtUtils::Install other than the version number
126 increase, but L<ExtUtils::Installed> has been upgraded from version 1.999_001
127 to version 1.999002 and a new C<skip_cwd> attribute has been added.
128
129 =item *
130
131 L<IPC::Open3> has been upgraded from version 1.11 to 1.12.
132
133 C<open3> with "-" for the program name works once more.  This was broken in
134 version 1.06 (and hence in Perl 5.14.0) [perl #95748].
135
136 =item *
137
138 L<Module::Build> has been upgraded from version 0.3800 to version 0.39_01.
139
140 Pod to HTML internals changed to support revisions to Pod::Html in core.
141 Also fixes some minor bugs. [rt.cpan.org #68585] [rt.cpan.org #67893]
142 [rt.cpan.org #67008]
143
144 =item *
145
146 L<Module::Load> has been upgraded from version 0.18 to version 0.20
147
148 =item *
149
150 L<Params::Check> has been upgraded from version 0.28 to version 0.30
151
152 =item *
153
154 L<PerlIO::via> has been upgraded from version 0.11 to version 0.12.
155
156 The only change is a correction in the documentation.
157
158 =item *
159
160 L<Term::ANSIColor> has been upgraded from version 3.00 to version 3.01
161
162 Only interpret an initial array reference as a list of colors, not any initial
163 reference, allowing the colored function to work properly on objects with
164 stringification defined.
165
166 =item *
167
168 L<Unicode::Collate> has been upgraded from version 0.77 to version 0.78
169
170 =item *
171
172 L<Unicode::Normalize> has been upgraded from version 1.12 to version 1.13
173
174 =back
175
176 =head2 Removed Modules and Pragmata
177
178 =over 4
179
180 =item *
181
182 XXX
183
184 =back
185
186 =head1 Documentation
187
188 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
189 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
190
191 =head2 New Documentation
192
193 XXX Changes which create B<new> files in F<pod/> go here.
194
195 =head3 L<XXX>
196
197 XXX Description of the purpose of the new file here
198
199 =head2 Changes to Existing Documentation
200
201 XXX Changes which significantly change existing files in F<pod/> go here.
202 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
203 section.
204
205 =head3 L<XXX>
206
207 =over 4
208
209 =item *
210
211 XXX Description of the change here
212
213 =back
214
215 =head1 Diagnostics
216
217 The following additions or changes have been made to diagnostic output,
218 including warnings and fatal error messages.  For the complete list of
219 diagnostic messages, see L<perldiag>.
220
221 XXX New or changed warnings emitted by the core's C<C> code go here. Also
222 include any changes in L<perldiag> that reconcile it to the C<C> code.
223
224 [ Within each section, list entries as a =item entry that links to perldiag,
225   e.g.
226
227   =item *
228
229   L<Invalid version object|perldiag/"Invalid version object">
230 ]
231
232 =head2 New Diagnostics
233
234 XXX Newly added diagnostic messages go here
235
236 =head3 New Errors
237
238 =over 4
239
240 =item *
241
242 XXX L<message|perldiag/"message">
243
244 =back
245
246 =head3 New Warnings
247
248 =over 4
249
250 =item *
251
252 XXX L<message|perldiag/"message">
253
254 =back
255
256 =head2 Changes to Existing Diagnostics
257
258 XXX Changes (i.e. rewording) of diagnostic messages go here
259
260 =over 4
261
262 =item *
263
264 XXX Describe change here
265
266 =back
267
268 =head1 Utility Changes
269
270 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
271 here. Most of these are built within the directories F<utils> and F<x2p>.
272
273 [ List utility changes as a =head3 entry for each utility and =item
274 entries for each change
275 Use L<XXX> with program names to get proper documentation linking. ]
276
277 =head3 L<perlivp>
278
279 =over 4
280
281 =item *
282
283 Fixed a bug whereby other perls under the current directory could cause
284 false positive failures.
285
286 =item *
287
288 Tests for .ph files have been removed, as these test have been optional since
289 2005 and .ph files are no longer generated during installation.
290
291 =back
292
293 =head1 Configuration and Compilation
294
295 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
296 go here.  Any other changes to the Perl build process should be listed here.
297 However, any platform-specific changes should be listed in the
298 L</Platform Support> section, instead.
299
300 [ List changes as a =item entry ].
301
302 =over 4
303
304 =item *
305
306 F<makedef.pl> has been refactored. This should have no noticeable affect on
307 any of the platforms that use it as part of their build (AIX, VMS, Win32).
308
309 =back
310
311 =head1 Testing
312
313 XXX Any significant changes to the testing of a freshly built perl should be
314 listed here.  Changes which create B<new> files in F<t/> go here as do any
315 large changes to the testing harness (e.g. when parallel testing was added).
316 Changes to existing files in F<t/> aren't worth summarising, although the bugs
317 that they represent may be covered elsewhere.
318
319 [ List each test improvement as a =item entry ]
320
321 =over 4
322
323 =item *
324
325 XXX
326
327 =back
328
329 =head1 Platform Support
330
331 XXX Any changes to platform support should be listed in the sections below.
332
333 [ Within the sections, list each platform as a =item entry with specific
334 changes as paragraphs below it. ]
335
336 =head2 New Platforms
337
338 XXX List any platforms that this version of perl compiles on, that previous
339 versions did not. These will either be enabled by new files in the F<hints/>
340 directories, or new subdirectories and F<README> files at the top level of the
341 source tree.
342
343 =over 4
344
345 =item XXX-some-platform
346
347 XXX
348
349 =back
350
351 =head2 Discontinued Platforms
352
353 XXX List any platforms that this version of perl no longer compiles on.
354
355 =over 4
356
357 =item XXX-some-platform
358
359 XXX
360
361 =back
362
363 =head2 Platform-Specific Notes
364
365 XXX List any changes for specific platforms. This could include configuration
366 and compilation changes or changes in portability/compatibility.  However,
367 changes within modules for platforms should generally be listed in the
368 L</Modules and Pragmata> section.
369
370 =over 4
371
372 =item XXX-some-platform
373
374 XXX
375
376 =back
377
378 =head1 Internal Changes
379
380 XXX Changes which affect the interface available to C<XS> code go here.
381 Other significant internal changes for future core maintainers should
382 be noted as well.
383
384 [ List each change as a =item entry ]
385
386 =over 4
387
388 =item *
389
390 XXX
391
392 =back
393
394 =head1 Selected Bug Fixes
395
396 XXX Important bug fixes in the core language are summarised here.
397 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
398 L</Modules and Pragmata>.
399
400 [ List each fix as a =item entry ]
401
402 =over 4
403
404 =item *
405
406 Locking an lvalue subroutine (via C<lock &lvsub>) now locks the return
407 value, instead of trying to lock the sub (which has no effect).  It also no
408 longer tries to return the sub as a scalar, resulting in strange side
409 effects like C<ref \$_> returning "CODE" in some instances.
410
411 =item *
412
413 C<lock>'s prototype has been corrected to C<(\[$@%*])> from C<(\$)>, which
414 was just wrong.
415
416 =item *
417
418 The prototypes for the core functions C<stat> and C<lstat> have been
419 removed, as they were incorrect, because their syntax cannot be replicated
420 by Perl subroutines.
421
422 =item *
423
424 Most dereferencing operators (C<${}>, etc.) used to call C<FETCH> twice on
425 a tied operand when doing a symbolic dereference (looking up a variable by
426 name, which is not permitted under C<use strict 'refs'>).  Only C<&{}> did
427 not have this problem.  This has been fixed.
428
429 =item *
430
431 A minor regression introduced in 5.15.0 has been fixed.  Dereferencing a
432 magical mortal (e.g., the return value of C<delete> on a tied hash element)
433 explicitly returned from a subroutine called recursively was not calling
434 C<FETCH>.  This would affect code like C<@{ foo() }> where the C<foo> sub
435 contains C<return delete $hash{elem}> and is calling itself.
436
437 =item *
438
439 A panic involving the combination of the regular expression modifiers
440 C</aa> and the C<\b> escape sequence introduced in 5.14.0 has been
441 fixed [perl #95964].
442
443 =item *
444
445 stat() would always return the inode number as an IV, even when the
446 original was unsigned, or too large to fit in an IV.  stat() now
447 returns the inode number as the type that would best preserve the
448 original value. [perl #84590]
449
450 =back
451
452 =head1 Known Problems
453
454 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
455 tests that had to be C<TODO>ed for the release would be noted here, unless
456 they were specific to a particular platform (see below).
457
458 This is a list of some significant unfixed bugs, which are regressions
459 from either 5.XXX.XXX or 5.XXX.XXX.
460
461 [ List each fix as a =item entry ]
462
463 =over 4
464
465 =item *
466
467 XXX
468
469 =back
470
471 =head1 Obituary
472
473 XXX If any significant core contributor has died, we've added a short obituary
474 here.
475
476 =head1 Acknowledgements
477
478 XXX Generate this with:
479
480   perl Porting/acknowledgements.pl v5.15.1..HEAD
481
482 =head1 Reporting Bugs
483
484 If you find what you think is a bug, you might check the articles
485 recently posted to the comp.lang.perl.misc newsgroup and the perl
486 bug database at http://rt.perl.org/perlbug/ .  There may also be
487 information at http://www.perl.org/ , the Perl Home Page.
488
489 If you believe you have an unreported bug, please run the L<perlbug>
490 program included with your release.  Be sure to trim your bug down
491 to a tiny but sufficient test case.  Your bug report, along with the
492 output of C<perl -V>, will be sent off to perlbug@perl.org to be
493 analysed by the Perl porting team.
494
495 If the bug you are reporting has security implications, which make it
496 inappropriate to send to a publicly archived mailing list, then please send
497 it to perl5-security-report@perl.org. This points to a closed subscription
498 unarchived mailing list, which includes
499 all the core committers, who will be able
500 to help assess the impact of issues, figure out a resolution, and help
501 co-ordinate the release of patches to mitigate or fix the problem across all
502 platforms on which Perl is supported. Please only use this address for
503 security issues in the Perl core, not for modules independently
504 distributed on CPAN.
505
506 =head1 SEE ALSO
507
508 The F<Changes> file for an explanation of how to view exhaustive details
509 on what changed.
510
511 The F<INSTALL> file for how to build Perl.
512
513 The F<README> file for general stuff.
514
515 The F<Artistic> and F<Copying> files for copyright information.
516
517 =cut