This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
8e0791a93b6d32f86517790c778935069b20fa6f
[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.17.1
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.17.0 release and
13 the 5.17.1 release.
14
15 If you are upgrading from an earlier release such as 5.16.0, first read
16 L<perl5170delta>, which describes differences between 5.16.0 and
17 5.17.0.
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 More CORE:: subs
32
33 Several more built-in functions have been added as subroutines to the
34 CORE:: namespace, namely, those non-overridable keywords that can be
35 implemented without custom parsers: C<defined>, C<delete>, C<exists>,
36 C<glob>, C<pos>, C<protoytpe>, C<scalar>, C<split>, C<study>, C<undef>,
37
38 As some of these have prototypes, C<prototype('CORE::...')> has been
39 changed not to make a distinction between overridable and non-overridable
40 keywords.  This is to make C<prototype('CORE::pos')> consistent with
41 C<prototype(&CORE::pos)>.
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 XXX For a release on a stable branch, this section aspires to be:
54
55     There are no changes intentionally incompatible with 5.XXX.XXX
56     If any exist, they are bugs, and we request that you submit a
57     report.  See L</Reporting Bugs> below.
58
59 =head2 C<\N{BELL}> now refers to U+1F514 instead of U+0007
60
61 Unicode 6.0 reused the name "BELL" for a different code point than it
62 traditionally had meant.  Since Perl v5.14, use of this name still
63 referred to U+0007, but would raise a deprecated warning.  Now, "BELL"
64 refers to U+1F514, and the name for U+0007 is "ALERT".  All the
65 functions in L<charnames> have been correspondingly updated.
66
67 =head1 Deprecations
68
69 XXX Any deprecated features, syntax, modules etc. should be listed here.
70 In particular, deprecated modules should be listed here even if they are
71 listed as an updated module in the L</Modules and Pragmata> section.
72
73 [ List each deprecation as a =head2 entry ]
74
75 =head1 Performance Enhancements
76
77 XXX Changes which enhance performance without changing behaviour go here. There
78 may well be none in a stable release.
79
80 [ List each enhancement as a =item entry ]
81
82 =over 4
83
84 =item *
85
86 XXX
87
88 =back
89
90 =head1 Modules and Pragmata
91
92 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
93 go here.  If Module::CoreList is updated, generate an initial draft of the
94 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
95 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
96 below.  A paragraph summary for important changes should then be added by hand.
97 In an ideal world, dual-life modules would have a F<Changes> file that could be
98 cribbed.
99
100 [ Within each section, list entries as a =item entry ]
101
102 =head2 New Modules and Pragmata
103
104 =over 4
105
106 =item *
107
108 XXX
109
110 =back
111
112 =head2 Updated Modules and Pragmata
113
114 =over 4
115
116 =item *
117
118 L<ExtUtils::CBuilder> has been upgraded from version 0.280206 to 0.280208.
119
120 Manifest files are now correctly embedded for those versions of VC++ which
121 make use of them.
122
123 =item *
124
125 L<B> has been upgraded from version 1.35 to 1.36.
126
127 C<B::COP::stashlen> has been replaced with C<B::COP::stashoff>.
128
129 C<B::COP::stashpv> now supports UTF8 package names and embedded nulls.
130
131 =item *
132
133 L<ExtUtils::CBuilder> has been upgraded from version 0.280206 to 0.280208.
134
135 It no longer fails when trying to embed manifests on Windows
136 [perl #111782, #111798].
137
138 =item *
139
140 L<File::DosGlob> has been upgraded from version 1.07 to 1.08.
141
142 There are no visible changes, only minor internal refactorings.
143
144 =item *
145
146 L<File::Spec::Unix> has been upgraded from version 3.39_02 to 3.39_03.
147
148 C<abs2rel> could produce incorrect results when given two relative paths or
149 the root directory twice [perl #111510].
150
151 =item *
152
153 L<IO> has been upgraded from version 1.25_06 to 1.25_07.
154
155 C<sync()> can now be called on read-only file handles [perl #64772].
156
157 =item *
158
159 L<Pod::Html> has been upgraded from version 1.15_02 to 1.16.
160
161 The option C<--libpods> has been re-instated. It is deprecated, and its use
162 does nothing other than issue a warning that it is no longer supported.
163
164 =item *
165
166 L<Unicode::UCD> has been upgraded from version 0.43 to 0.44.
167
168 This adds a function L<all_casefolds()|Unicode::UCD/all_casefolds()>
169 that returns all the casefolds.
170
171 =back
172
173 =head2 Removed Modules and Pragmata
174
175 =over 4
176
177 =item *
178
179 XXX
180
181 =back
182
183 =head1 Documentation
184
185 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
186 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
187
188 =head2 New Documentation
189
190 XXX Changes which create B<new> files in F<pod/> go here.
191
192 =head3 L<XXX>
193
194 XXX Description of the purpose of the new file here
195
196 =head2 Changes to Existing Documentation
197
198 XXX Changes which significantly change existing files in F<pod/> go here.
199 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
200 section.
201
202 =head3 L<XXX>
203
204 =over 4
205
206 =item *
207
208 XXX Description of the change here
209
210 =back
211
212 =head1 Diagnostics
213
214 The following additions or changes have been made to diagnostic output,
215 including warnings and fatal error messages.  For the complete list of
216 diagnostic messages, see L<perldiag>.
217
218 XXX New or changed warnings emitted by the core's C<C> code go here. Also
219 include any changes in L<perldiag> that reconcile it to the C<C> code.
220
221 [ Within each section, list entries as a =item entry that links to perldiag,
222   e.g.
223
224   =item *
225
226   L<Invalid version object|perldiag/"Invalid version object">
227 ]
228
229 =head2 New Diagnostics
230
231 XXX Newly added diagnostic messages go here
232
233 =head3 New Errors
234
235 =over 4
236
237 =item *
238
239 XXX L<message|perldiag/"message">
240
241 =back
242
243 =head3 New Warnings
244
245 =over 4
246
247 =item *
248
249 XXX L<message|perldiag/"message">
250
251 =back
252
253 =head2 Changes to Existing Diagnostics
254
255 XXX Changes (i.e. rewording) of diagnostic messages go here
256
257 =over 4
258
259 =item *
260
261 XXX Describe change here
262
263 =back
264
265 =head2 Removals of Diagnostics
266
267 =over 4
268
269 =item *
270
271 The "Runaway prototype" warning that occurs in bizarre cases has been
272 removed as being unhelpful and inconsistent.
273
274 =item *
275
276 The "Not a format reference" error has been removed, as the only case in
277 which it could be triggered was a bug.
278
279 =back
280
281 =head1 Utility Changes
282
283 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
284 here. Most of these are built within the directories F<utils> and F<x2p>.
285
286 [ List utility changes as a =head3 entry for each utility and =item
287 entries for each change
288 Use L<XXX> with program names to get proper documentation linking. ]
289
290 =head3 L<XXX>
291
292 =over 4
293
294 =item *
295
296 XXX
297
298 =back
299
300 =head1 Configuration and Compilation
301
302 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
303 go here.  Any other changes to the Perl build process should be listed here.
304 However, any platform-specific changes should be listed in the
305 L</Platform Support> section, instead.
306
307 [ List changes as a =item entry ].
308
309 =over 4
310
311 =item *
312
313 XXX
314
315 =back
316
317 =head1 Testing
318
319 XXX Any significant changes to the testing of a freshly built perl should be
320 listed here.  Changes which create B<new> files in F<t/> go here as do any
321 large changes to the testing harness (e.g. when parallel testing was added).
322 Changes to existing files in F<t/> aren't worth summarising, although the bugs
323 that they represent may be covered elsewhere.
324
325 [ List each test improvement as a =item entry ]
326
327 =over 4
328
329 =item *
330
331 XXX
332
333 =back
334
335 =head1 Platform Support
336
337 XXX Any changes to platform support should be listed in the sections below.
338
339 [ Within the sections, list each platform as a =item entry with specific
340 changes as paragraphs below it. ]
341
342 =head2 New Platforms
343
344 XXX List any platforms that this version of perl compiles on, that previous
345 versions did not. These will either be enabled by new files in the F<hints/>
346 directories, or new subdirectories and F<README> files at the top level of the
347 source tree.
348
349 =over 4
350
351 =item XXX-some-platform
352
353 XXX
354
355 =back
356
357 =head2 Discontinued Platforms
358
359 XXX List any platforms that this version of perl no longer compiles on.
360
361 =over 4
362
363 =item XXX-some-platform
364
365 XXX
366
367 =back
368
369 =head2 Platform-Specific Notes
370
371 XXX List any changes for specific platforms. This could include configuration
372 and compilation changes or changes in portability/compatibility.  However,
373 changes within modules for platforms should generally be listed in the
374 L</Modules and Pragmata> section.
375
376 =over 4
377
378 =item Win32
379
380 C<link> on Win32 now attempts to set C<$!> to more appropriate values
381 based on the Win32 API error code. [perl #112272]
382
383 =back
384
385 =head1 Internal Changes
386
387 XXX Changes which affect the interface available to C<XS> code go here.
388 Other significant internal changes for future core maintainers should
389 be noted as well.
390
391 [ List each change as a =item entry ]
392
393 =over 4
394
395 =item *
396
397 The C<study> function was made a no-op in 5.16.  It was simply disabled via
398 a C<return> statement; the code was left in place.  Now the code supporting
399 what C<study> used to do has been removed.
400
401 =item *
402
403 Under threaded perls, there is no longer a separate PV allocated for every
404 COP to store its package name (C<< cop->stashpv >>).  Instead, there is an
405 offset (C<< cop->stashoff >>) into the new C<PL_stashpad> array, which
406 holds stash pointers.
407
408 =back
409
410 =head1 Selected Bug Fixes
411
412 XXX Important bug fixes in the core language are summarised here.
413 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
414 L</Modules and Pragmata>.
415
416 [ List each fix as a =item entry ]
417
418 =over 4
419
420 =item *
421
422 Perl now works as well as can be expected on all releases of Unicode so
423 far.  In v5.16, it worked on Unicodes 6.0 and 6.1, but there were
424 various bugs for earlier releases; the older the release the more
425 problems.
426
427 =item *
428
429 C<vec> no longer produces "uninitialized" warnings in lvalue context
430 [perl #9423].
431
432 =item *
433
434 An optimisation involving fixed strings in regular expressions could cause
435 a severe performance penalty in edge cases.  This has been fixed
436 [perl #76546].
437
438 =item *
439
440 The "Can't find an opnumber" message that C<prototype> produces when passed
441 a string like "CORE::nonexistent_keyword" is now passes UTF8 and embedded
442 nulls through unchanged [perl #97478].
443
444 =item *
445
446 C<prototype> now treats magical variables like C<$1> the same way as
447 non-magical variables when checking for the CORE:: prefix, instead of
448 treating them as subroutine names.
449
450 =item *
451
452 Under threaded perls, a run-time code block in a regular expression could
453 corrupt the package name stored in the op tree, resulting in bad reads
454 in C<caller>, and possibly crashes [perl #113060].
455
456 =item *
457
458 Referencing a closure prototype (C<\&{$_[1]}> in an attribute handler for a
459 closure) no longer results in a copy of the subroutine (or assertion
460 failures on debugging builds).
461
462 =item *
463
464 C<eval '__PACKAGE__'> now returns the right answer on threaded builds if
465 the current package has been assigned over (as in
466 C<*ThisPackage:: = *ThatPackage::>) [perl #78742].
467
468 =item *
469
470 If a package is deleted by code that it calls, it is possible for C<caller>
471 to see a stack frame belonging to that deleted package.  C<caller> could
472 crash if the stash's memory address was reused for a scalar and a
473 substitution was performed on the same scalar [perl #113486].
474
475 =item *
476
477 C<UNIVERSAL::can> no longer treats its first argument differently
478 depending on whether it is a string or number internally.
479
480 =item *
481
482 C<open> with "<&" for the mode checks to see whether the third argument is
483 a number, in determining whether to treat it as a file descriptor or a
484 handle name.  Magical variables like C<$1> were always failing the numeric
485 check and being treated as handle names.
486
487 =item *
488
489 C<warn>'s handling of magical variables (C<$1>, ties) has undergone several
490 fixes.  FETCH is only called once now on a tied argument or a tied C<$@>
491 [perl #97480].  Tied variables returning objects that stringify as "" are
492 no longer ignored.  A tied C<$@> that happened to return a reference the
493 I<previous> time is was used is no longer ignored.
494
495 =item *
496
497 Numeric operators on magical variables (e.g., S<C<$1 + 1>>) used to use
498 floating point operations even where integer operations were more appropriate, resulting in loss of accuracy on 64-bit platforms
499 [perl #109542].
500
501 =item *
502
503 Unary negation no longer treats a string as a number if the string happened
504 to be used as a number some time.  So, if $x contains the string "dogs",
505 C<-$x> returns "-dogs" even if C<$y=0+$x> has happened at some point.
506
507 =item *
508
509 In Perl 5.14, C<-'-10'> was fixed to return "10", not "+10".  But magical
510 variables (C<$1>, ties) were not fixed till now [perl #57706].
511
512 =back
513
514 =head1 Known Problems
515
516 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
517 tests that had to be C<TODO>ed for the release would be noted here, unless
518 they were specific to a particular platform (see below).
519
520 This is a list of some significant unfixed bugs, which are regressions
521 from either 5.XXX.XXX or 5.XXX.XXX.
522
523 [ List each fix as a =item entry ]
524
525 =over 4
526
527 =item *
528
529 XXX
530
531 =back
532
533 =head1 Obituary
534
535 XXX If any significant core contributor has died, we've added a short obituary
536 here.
537
538 =head1 Acknowledgements
539
540 XXX Generate this with:
541
542   perl Porting/acknowledgements.pl v5.17.0..HEAD
543
544 =head1 Reporting Bugs
545
546 If you find what you think is a bug, you might check the articles
547 recently posted to the comp.lang.perl.misc newsgroup and the perl
548 bug database at http://rt.perl.org/perlbug/ .  There may also be
549 information at http://www.perl.org/ , the Perl Home Page.
550
551 If you believe you have an unreported bug, please run the L<perlbug>
552 program included with your release.  Be sure to trim your bug down
553 to a tiny but sufficient test case.  Your bug report, along with the
554 output of C<perl -V>, will be sent off to perlbug@perl.org to be
555 analysed by the Perl porting team.
556
557 If the bug you are reporting has security implications, which make it
558 inappropriate to send to a publicly archived mailing list, then please send
559 it to perl5-security-report@perl.org. This points to a closed subscription
560 unarchived mailing list, which includes
561 all the core committers, who will be able
562 to help assess the impact of issues, figure out a resolution, and help
563 co-ordinate the release of patches to mitigate or fix the problem across all
564 platforms on which Perl is supported. Please only use this address for
565 security issues in the Perl core, not for modules independently
566 distributed on CPAN.
567
568 =head1 SEE ALSO
569
570 The F<Changes> file for an explanation of how to view exhaustive details
571 on what changed.
572
573 The F<INSTALL> file for how to build Perl.
574
575 The F<README> file for general stuff.
576
577 The F<Artistic> and F<Copying> files for copyright information.
578
579 =cut