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