This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for #113932 (UNIVERSAL::can)
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
38663f11
DG
5[ this is a template for a new perldelta file. Any text flagged as XXX needs
6to be processed before release. ]
7
8perldelta - what is new for perl v5.19.2
e128ab2c 9
4eabcf70 10=head1 DESCRIPTION
6db9054f 11
38663f11 12This document describes differences between the 5.19.1 release and the 5.19.2
e08634c5 13release.
6db9054f 14
38663f11
DG
15If you are upgrading from an earlier release such as 5.19.0, first read
16L<perl5191delta>, which describes differences between 5.19.0 and 5.19.1.
42bff0d9 17
38663f11 18=head1 Notice
42bff0d9 19
38663f11 20XXX Any important notices here
d69d1f92 21
38663f11 22=head1 Core Enhancements
287d2d21 23
38663f11
DG
24XXX New core language features go here. Summarize user-visible core language
25enhancements. Particularly prominent performance optimisations could go
26here, but most should go in the L</Performance Enhancements> section.
287d2d21 27
ba90f48b
FC
28=head2 More consistent prototype parsing
29
30Multiple semicolons in subroutine prototypes have long been tolerated and
31treated as a single semicolon. There was one case where this did not
32happen. A subroutine whose prototype begins with "*" or ";*" can affect
33whether a bareword is considered a method name or sub call. This now
34applies also to ";;;*".
35
36Whitespace has long been allowed inside subroutine prototypes, so
37C<sub( $ $ )> is equivalent to C<sub($$)>. But it was stripped when the
38subroutine was parse. Hence, whitespace was I<not> allowed in prototypes
39set by C<Scalar::Util::set_prototype>. Now it is permitted, and the parser
40no longer strips whitespace. This means C<prototype &mysub> returns the
41original prototype, whitespace and all.
287d2d21 42
38663f11 43=head1 Security
42bff0d9 44
38663f11
DG
45XXX Any security-related notices go here. In particular, any security
46vulnerabilities closed should be noted here rather than in the
47L</Selected Bug Fixes> section.
42bff0d9 48
38663f11 49[ List each security issue as a =head2 entry ]
42bff0d9 50
38663f11 51=head1 Incompatible Changes
42bff0d9 52
38663f11 53XXX For a release on a stable branch, this section aspires to be:
42bff0d9 54
38663f11
DG
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.
42bff0d9 58
38663f11 59[ List each incompatible change as a =head2 entry ]
42bff0d9 60
38663f11 61=head1 Deprecations
42bff0d9 62
38663f11 63XXX Any deprecated features, syntax, modules etc. should be listed here.
42bff0d9 64
38663f11 65=head2 Module removals
42bff0d9 66
38663f11 67XXX Remove this section if inapplicable.
42bff0d9 68
8c33633d
FC
69The following modules will be removed from the core distribution in a
70future release, and will at that time need to be installed from CPAN.
71Distributions on CPAN which require these modules will need to list them as
72prerequisites.
42bff0d9 73
38663f11 74The core versions of these modules will now issue C<"deprecated">-category
8c33633d 75warnings to alert you to this fact. To silence these deprecation warnings,
38663f11 76install the modules in question from CPAN.
42bff0d9 77
38663f11 78Note that these are (with rare exceptions) fine modules that you are encouraged
8c33633d 79to continue to use. Their disinclusion from core primarily hinges on their
38663f11
DG
80necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
81not usually on concerns over their design.
42bff0d9 82
38663f11 83=over
42bff0d9 84
38663f11
DG
85XXX Note that deprecated modules should be listed here even if they are listed
86as an updated module in the L</Modules and Pragmata> section.
42bff0d9 87
38663f11 88=back
42bff0d9 89
38663f11 90[ List each other deprecation as a =head2 entry ]
42bff0d9 91
38663f11 92=head1 Performance Enhancements
42bff0d9 93
38663f11
DG
94XXX Changes which enhance performance without changing behaviour go here.
95There may well be none in a stable release.
42bff0d9 96
38663f11 97[ List each enhancement as a =item entry ]
42bff0d9 98
38663f11 99=over 4
42bff0d9
DG
100
101=item *
102
38663f11 103XXX
42bff0d9 104
38663f11 105=back
42bff0d9 106
38663f11 107=head1 Modules and Pragmata
42bff0d9 108
38663f11
DG
109XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
110go here. If Module::CoreList is updated, generate an initial draft of the
111following sections using F<Porting/corelist-perldelta.pl>, which prints stub
112entries to STDOUT. Results can be pasted in place of the '=head2' entries
113below. A paragraph summary for important changes should then be added by hand.
114In an ideal world, dual-life modules would have a F<Changes> file that could be
115cribbed.
42bff0d9 116
38663f11 117[ Within each section, list entries as a =item entry ]
42bff0d9 118
38663f11 119=head2 New Modules and Pragmata
42bff0d9 120
38663f11 121=over 4
42bff0d9
DG
122
123=item *
124
38663f11 125XXX
42bff0d9 126
38663f11 127=back
42bff0d9 128
38663f11 129=head2 Updated Modules and Pragmata
42bff0d9 130
38663f11 131=over 4
42bff0d9
DG
132
133=item *
134
893b07a1
NC
135L<ExtUtils::Embed> has been upgraded from version 1.30 to 1.31
136
137The generated C<C> code now incorporates bug fixes present in
138F<miniperlmain.c>, and has whitespace changes. It now uses
139C<#include "..."> for header files instead of C<< #include <...> >>.
140This should not make any difference, unless programs embedding C<libperl>
141happen to have local and incompatible files named F<EXTERN.h>, F<XSUB.h> or
142F<perl.h>, as these will now be picked up instead of the installed Perl
143headers.
144
145=item *
146
147L<ExtUtils::Miniperl> has been upgraded and given a version of 1.
148Previously it did not have a version number.
149
150C<writemain()> now takes an optional first argument. A reference to a scalar
151is treated as a filename to be opened and written to. Any other reference is
152used as the filehandle to write to. Otherwise the existing default remains,
153to write to C<STDOUT>.
154
155C<writemain()> has been refactored to use functions from L<ExtUtils::Embed>,
156reducing code size and duplication. The internal function C<canon()> has been
157deleted.
158
159=item *
160
70ba8092
TC
161L<POSIX> has been upgraded from version 1.33 to 1.34.
162
163C<POSIX::AUTOLOAD> will no longer infinitely recurse if the shared
164object fails to load.
42bff0d9 165
6e4979f3
TC
166=item *
167
168L<Storable> has been upgraded from version 2.43 to 2.44.
169
170Calling C<STORABLE_attach> hooks no longer leaks memory. [perl #118829]
171
38663f11 172=back
42bff0d9 173
38663f11 174=head2 Removed Modules and Pragmata
42bff0d9 175
38663f11 176=over 4
42bff0d9
DG
177
178=item *
179
38663f11 180XXX
42bff0d9 181
38663f11 182=back
42bff0d9 183
38663f11 184=head1 Documentation
42bff0d9 185
38663f11
DG
186XXX Changes to files in F<pod/> go here. Consider grouping entries by
187file and be sure to link to the appropriate page, e.g. L<perlfunc>.
42bff0d9 188
38663f11 189=head2 New Documentation
42bff0d9 190
38663f11 191XXX Changes which create B<new> files in F<pod/> go here.
42bff0d9 192
38663f11 193=head3 L<XXX>
42bff0d9 194
38663f11 195XXX Description of the purpose of the new file here
42bff0d9 196
38663f11 197=head2 Changes to Existing Documentation
42bff0d9 198
38663f11
DG
199XXX Changes which significantly change existing files in F<pod/> go here.
200However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
201section.
dbd04185 202
41f6d116 203=head3 L<perlexperiment>
dbd04185 204
38663f11 205=over 4
583aa5c2 206
1fdd5e53
KW
207=item *
208
41f6d116
RS
209Code in regular expressions, regular expression backtracking verbs,
210and lvalue subroutines are no longer listed as experimental. (This
211also affects L<perlre> and L<perlsub>.)
42bff0d9 212
38663f11 213=back
42bff0d9 214
989e4501
FC
215=head3 L<perlfunc>
216
217=over 4
218
219=item *
220
221Since Perl v5.10, it has been possible for subroutines in @INC to return
222a reference to a scalar holding initial source code to prepend to the file.
223This is now documented.
224
225=back
226
38663f11 227=head1 Diagnostics
42bff0d9 228
38663f11
DG
229The following additions or changes have been made to diagnostic output,
230including warnings and fatal error messages. For the complete list of
231diagnostic messages, see L<perldiag>.
42bff0d9 232
38663f11
DG
233XXX New or changed warnings emitted by the core's C<C> code go here. Also
234include any changes in L<perldiag> that reconcile it to the C<C> code.
42bff0d9 235
38663f11 236=head2 New Diagnostics
42bff0d9 237
38663f11
DG
238XXX Newly added diagnostic messages go under here, separated into New Errors
239and New Warnings
42bff0d9 240
38663f11 241=head3 New Errors
42bff0d9 242
38663f11 243=over 4
42bff0d9
DG
244
245=item *
246
38663f11 247XXX L<message|perldiag/"message">
1fdd5e53 248
583aa5c2
RS
249=back
250
38663f11 251=head3 New Warnings
583aa5c2 252
38663f11 253=over 4
583aa5c2 254
b8a02ff1 255=item *
583aa5c2 256
38663f11 257XXX L<message|perldiag/"message">
583aa5c2 258
b8a02ff1 259=back
583aa5c2 260
38663f11 261=head2 Changes to Existing Diagnostics
96d496e4 262
38663f11 263XXX Changes (i.e. rewording) of diagnostic messages go here
b8a02ff1 264
38663f11 265=over 4
b8a02ff1
DG
266
267=item *
268
bfb4a93c
FC
269Under rare circumstances, one could get a "Can't coerce readonly REF to
270string" instead of the customary "Modification of a read-only value". This
271alternate error message has been removed.
96d496e4 272
73951195
FC
273=item *
274
275"Ambiguous use of * resolved as operator *": This and similar warnings
276about "%" and "&" used to occur in some circumstances where there was no
277operator of the type cited, so the warning was completely wrong. This has
278been fixed [perl #117535, #76910].
279
96d496e4
RS
280=back
281
38663f11 282=head1 Utility Changes
d7bfa554 283
38663f11
DG
284XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
285Most of these are built within the directories F<utils> and F<x2p>.
d7bfa554 286
38663f11
DG
287[ List utility changes as a =head3 entry for each utility and =item
288entries for each change
289Use L<XXX> with program names to get proper documentation linking. ]
d7bfa554 290
38663f11 291=head3 L<XXX>
583aa5c2
RS
292
293=over 4
1993add8 294
e9912eaa 295=item *
ec985017 296
38663f11 297XXX
583aa5c2
RS
298
299=back
300
38663f11 301=head1 Configuration and Compilation
583aa5c2 302
38663f11
DG
303XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
304go here. Any other changes to the Perl build process should be listed here.
305However, any platform-specific changes should be listed in the
306L</Platform Support> section, instead.
583aa5c2 307
38663f11 308[ List changes as a =item entry ].
583aa5c2
RS
309
310=over 4
71e6aba6 311
d5f315e8
KW
312=item *
313
e38fc308
NC
314F<installperl> and F<installman>'s option handling has been refactored to use
315L<Getopt::Long>. Both are used by the F<Makefile> C<install> targets, and
316are not installed, so these changes are only likely to affect custom
317installation scripts.
318
319=over 4
320
321=item *
322
323single letter options now also have long names
324
325=item *
326
327invalid options are now rejected
328
329=item *
330
331command line arguments that are not options are now rejected
332
333=item *
334
335Each now has a C<--help> option to display the usage message.
336
337=back
338
339The behaviour for all valid documented invocations is unchanged.
d5f315e8 340
337fb649 341=back
2426c394 342
38663f11 343=head1 Testing
357b01df 344
38663f11
DG
345XXX Any significant changes to the testing of a freshly built perl should be
346listed here. Changes which create B<new> files in F<t/> go here as do any
347large changes to the testing harness (e.g. when parallel testing was added).
348Changes to existing files in F<t/> aren't worth summarizing, although the bugs
349that they represent may be covered elsewhere.
4724da03 350
38663f11 351[ List each test improvement as a =item entry ]
357b01df 352
583aa5c2 353=over 4
357b01df 354
583aa5c2 355=item *
357b01df 356
38663f11 357XXX
4724da03 358
38663f11 359=back
4724da03 360
38663f11 361=head1 Platform Support
4724da03 362
38663f11 363XXX Any changes to platform support should be listed in the sections below.
4724da03 364
38663f11
DG
365[ Within the sections, list each platform as a =item entry with specific
366changes as paragraphs below it. ]
4724da03 367
38663f11 368=head2 New Platforms
4724da03 369
38663f11
DG
370XXX List any platforms that this version of perl compiles on, that previous
371versions did not. These will either be enabled by new files in the F<hints/>
372directories, or new subdirectories and F<README> files at the top level of the
373source tree.
4724da03 374
38663f11 375=over 4
357b01df 376
38663f11 377=item XXX-some-platform
583aa5c2 378
38663f11 379XXX
4724da03 380
38663f11 381=back
583aa5c2 382
583aa5c2
RS
383=head2 Discontinued Platforms
384
38663f11
DG
385XXX List any platforms that this version of perl no longer compiles on.
386
583aa5c2
RS
387=over 4
388
38663f11 389=item XXX-some-platform
d7bfa554 390
38663f11 391XXX
d7bfa554 392
583aa5c2
RS
393=back
394
395=head2 Platform-Specific Notes
396
38663f11
DG
397XXX List any changes for specific platforms. This could include configuration
398and compilation changes or changes in portability/compatibility. However,
399changes within modules for platforms should generally be listed in the
400L</Modules and Pragmata> section.
583aa5c2 401
38663f11 402=over 4
a34da6c4 403
3a0b4597 404=item MidnightBSD
a34da6c4 405
3a0b4597 406C<objformat> was removed from version 0.4-RELEASE of MidnightBSD and had been
8c33633d
FC
407deprecated on earlier versions. This caused the build environment to be
408erroneously configured for C<a.out> rather than C<elf>. This has been now
3a0b4597 409been corrected.
a34da6c4 410
583aa5c2
RS
411=back
412
413=head1 Internal Changes
414
38663f11
DG
415XXX Changes which affect the interface available to C<XS> code go here. Other
416significant internal changes for future core maintainers should be noted as
417well.
583aa5c2 418
38663f11 419[ List each change as a =item entry ]
583aa5c2 420
38663f11 421=over 4
1de7c8e6 422
d7bfa554
DG
423=item *
424
eca6ff41
NC
425The Makefile shortcut targets for many rarely (or never) used testing and
426profiling targets have been removed, or merged into the only other Makefile
8c33633d 427target that uses them. Specifically, these targets are gone, along with
eca6ff41
NC
428documentation that referenced them or explained how to use them:
429
9d4d67dd
NC
430 check.third check.utf16 check.utf8 coretest minitest.prep
431 minitest.utf16 perl.config.dashg perl.config.dashpg
432 perl.config.gcov perl.gcov perl.gprof perl.gprof.config
433 perl.pixie perl.pixie.atom perl.pixie.config perl.pixie.irix
434 perl.third perl.third.config perl.valgrind.config purecovperl
435 pureperl quantperl test.deparse test.taintwarn test.third
436 test.torture test.utf16 test.utf8 test_notty.deparse
437 test_notty.third test_notty.valgrind test_prep.third
438 test_prep.valgrind torturetest ucheck ucheck.third ucheck.utf16
439 ucheck.valgrind utest utest.third utest.utf16 utest.valgrind
eca6ff41
NC
440
441It's still possible to run the relevant commands by "hand" - no underlying
442functionality has been removed.
d7bfa554 443
9c800862
KW
444=item *
445
446It is now possible to keep Perl from initializing locale handling.
447For the most part, Perl doesn't pay attention to locale. (See
448L<perllocale>.) Nonetheless, until now, on startup, it has always
449initialized locale handling to the system default, just in case the
450program being executed ends up using locales. (This is one of the first
451things a locale-aware program should do, long before Perl knows if it
452will actually be needed or not.) This works well except when Perl is
453embedded in another application which wants a locale that isn't the
454system default. Now, if the environment variable
455C<PERL_SKIP_LOCALE_INIT> is set at the time Perl is started, this
456initialization step is skipped. Prior to this, on Windows platforms,
457the only workaround for this deficiency was to use a hacked-up copy of
458internal Perl code. Applications that need to use older Perls can
459discover if the embedded Perl they are using needs the workaround by
460testing that the C preprocessor symbol C<HAS_SKIP_LOCALE_INIT> is not
461defined. (RT #38193)
462
aaf54772
FC
463=item *
464
465C<BmRARE> and C<BmPREVIOUS> have been removed. They were not used anywhere
466and are not part of the API. For XS modules, they are now #defined as 0.
467
b7bbd8b6
FC
468=item *
469
470C<sv_force_normal>, which usually croaks on read-only values, used to allow
471read-only values to be modified at compile time. This has been changed to
472croak on read-only values regardless. This change uncovered several core
473bugs.
474
583aa5c2
RS
475=back
476
477=head1 Selected Bug Fixes
478
38663f11
DG
479XXX Important bug fixes in the core language are summarized here. Bug fixes in
480files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
acfe52c8 481
38663f11 482[ List each fix as a =item entry ]
a2ef523e 483
38663f11 484=over 4
42dd67ca 485
e0d46238
FC
486=item *
487
52c411a5 488There have been several fixes related to Perl's handling of locales. perl
9c800862
KW
489#38193 was described above in L</Internal Changes>.
490Also fixed is #112208 in which the error string in C<$!> displayed as
491garbage in many UTF-8 locales;
492#118197, where the radix (decimal point) character had to be an ASCII
493character (which doesn't work for some non-Western languages);
52c411a5 494and #115808, in which C<POSIX::setlocale()> on failure returned an
9c800862
KW
495C<undef> which didn't warn about not being defined even if those
496warnings were enabled.
d7bfa554 497
81d3ed5a
FC
498=item *
499
500The dtrace sub-entry probe now works with lexical subs, instead of
501crashing [perl #118305].
502
0b023496
FC
503=item *
504
505Compiling a C<split> operator whose third argument is a named constant
506evaulating to 0 no longer causes the constant's value to change.
507
e11f653d
FC
508=item *
509
510A named constant used as the second argument to C<index> no longer gets
5e0164b2
FC
511coerced to a string if it is a reference, regular expression, dualvar, etc.
512
513=item *
514
515A named constant evaluating to the undefined value used as the second
516argument to C<index> no longer produces "uninitialized" warnings at compile
517time. It will still produce them at run time.
e11f653d 518
8be8cdec
FC
519=item *
520
521When a scalar was returned from a subroutine in @INC, the referenced scalar
522was magically converted into an IO thingy, possibly resulting in "Bizarre
523copy" errors if that scalar continued to be used elsewhere. Now Perl uses
524an internal copy of the scalar instead.
525
07a522a5
FC
526=item *
527
528Undefining an inlinable lexical subroutine (C<my sub foo() { 42 } undef
529&foo>) would result in a crash if warnings were turned on.
530
71b4007c
FC
531=item *
532
533Certain uses of the C<sort> operator are optimised to modify an array in
534place, such as C<@a = sort @a>. During the sorting, the array is made
535read-only. If a sort block should happen to die, then the array remained
536read-only even outside the C<sort>. This has been fixed.
537
f6b1d2f5
FC
538=item *
539
540C<$a> and C<$b> inside a sort block are aliased to the actual arguments to
541C<sort>, so they can be modified through those two variables. This did not
542always work, e.g., for lvalue subs and C<$#ary>, and probably many other
543operators. It works now.
544
7e4f209b
FC
545=item *
546
547The arguments to C<sort> are now all in list context. If the C<sort>
548itself were called in void or scalar context, then I<some>, but not all, of
549the arguments used to be in void or scalar context.
550
558673e6
FC
551=item *
552
553Subroutine prototypes with Unicode characters above U+00FF were getting
554mangled during closure cloning. This would happen with subroutines closing
555over lexical variables declared outside, and with lexical subs.
556
47a7c93d
FC
557=item *
558
559In regular expressions containing multiple code blocks, the values of
560C<$1>, C<$2>, etc., set by nested regular expression calls would leak from
561one block to the next. Now these variables always refer to the outer
562regular expression at the start of an embedded block [perl #117917].
563
b5a80c26
FC
564=item *
565
566C<UNIVERSAL::can> now treats its first argument the same way that method
567calls do: Typeglobs and glob references with non-empty IO slots are treated
568as handles, and strings are treated as filehandles, rather than packages,
569if a handle with that name exists [perl #113932].
570
38663f11 571=back
d7bfa554 572
38663f11 573=head1 Known Problems
6810f0ad 574
38663f11
DG
575XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
576tests that had to be C<TODO>ed for the release would be noted here. Unfixed
577platform specific bugs also go here.
6810f0ad 578
38663f11 579[ List each fix as a =item entry ]
0e417e4d 580
38663f11 581=over 4
14fd9356
FC
582
583=item *
584
38663f11 585XXX
0e417e4d 586
38663f11 587=back
583aa5c2 588
38663f11 589=head1 Obituary
583aa5c2 590
38663f11
DG
591XXX If any significant core contributor has died, we've added a short obituary
592here.
583aa5c2 593
583aa5c2 594=head1 Acknowledgements
a75569c0 595
38663f11
DG
596XXX Generate this with:
597
598 perl Porting/acknowledgements.pl v5.19.1..HEAD
f5b73711 599
44691e6f
AB
600=head1 Reporting Bugs
601
e08634c5
SH
602If you find what you think is a bug, you might check the articles recently
603posted to the comp.lang.perl.misc newsgroup and the perl bug database at
604http://rt.perl.org/perlbug/ . There may also be information at
605http://www.perl.org/ , the Perl Home Page.
44691e6f 606
e08634c5
SH
607If you believe you have an unreported bug, please run the L<perlbug> program
608included with your release. Be sure to trim your bug down to a tiny but
609sufficient test case. Your bug report, along with the output of C<perl -V>,
610will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
611
612If the bug you are reporting has security implications, which make it
e08634c5
SH
613inappropriate to send to a publicly archived mailing list, then please send it
614to perl5-security-report@perl.org. This points to a closed subscription
615unarchived mailing list, which includes all the core committers, who will be
616able to help assess the impact of issues, figure out a resolution, and help
f9001595 617co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
618platforms on which Perl is supported. Please only use this address for
619security issues in the Perl core, not for modules independently distributed on
620CPAN.
44691e6f
AB
621
622=head1 SEE ALSO
623
e08634c5
SH
624The F<Changes> file for an explanation of how to view exhaustive details on
625what changed.
44691e6f
AB
626
627The F<INSTALL> file for how to build Perl.
628
629The F<README> file for general stuff.
630
631The F<Artistic> and F<Copying> files for copyright information.
632
633=cut