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