This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta - Remove all but one XXX notices
[perl5.git] / pod / perldelta.pod
index bd6de58..11c60a7 100644 (file)
@@ -1,19 +1,7 @@
 =encoding utf8
 
-=for comment
-Stuff that needs to be done still:
-70502ce [perl #119101] Extraneous warnings in Parse::ErrorString::Perl
-88b3a46 PATCH (partial) [perl #107816] Performance regression since 0abd0d78
-eb40d2c [perl #2726] Prototype is not applied until BLOCK is defined
-c56ed9f [perl #119043] Allow utf8 up/downgrade on ro COWs
-8fe3c67 fix 114884 positive GPOS lookbehind regex substitution failure
-d8fe30a Avoid read-after-free in S_scan_heredoc() if the terminator line has no "\n".
-
 =head1 NAME
 
-[ this is a template for a new perldelta file.  Any text flagged as XXX needs
-to be processed before release. ]
-
 perldelta - what is new for perl v5.19.3
 
 =head1 DESCRIPTION
@@ -24,18 +12,8 @@ release.
 If you are upgrading from an earlier release such as 5.19.1, first read
 L<perl5192delta>, which describes differences between 5.19.1 and 5.19.2.
 
-=head1 Notice
-
-XXX Any important notices here
-
 =head1 Core Enhancements
 
-XXX New core language features go here.  Summarize user-visible core language
-enhancements.  Particularly prominent performance optimisations could go
-here, but most should go in the L</Performance Enhancements> section.
-
-[ List each enhancement as a =head2 entry ]
-
 =head2 B<-F> now implies B<-a> and B<-a> implies B<-n>
 
 Previously B<-F> without B<-a> was a no-op, and B<-a> without B<-n> or B<-p>
@@ -46,90 +24,27 @@ You can still use B<-p> for its extra behaviour. [perl #116190]
 
 =head1 Security
 
-XXX Any security-related notices go here.  In particular, any security
-vulnerabilities closed should be noted here rather than in the
-L</Selected Bug Fixes> section.
-
-[ List each security issue as a =head2 entry ]
-
-=head1 Incompatible Changes
-
-XXX For a release on a stable branch, this section aspires to be:
-
-    There are no changes intentionally incompatible with 5.XXX.XXX
-    If any exist, they are bugs, and we request that you submit a
-    report.  See L</Reporting Bugs> below.
-
-[ List each incompatible change as a =head2 entry ]
-
-=head1 Deprecations
-
-XXX Any deprecated features, syntax, modules etc. should be listed here.
-
-=head2 Module removals
-
-XXX Remove this section if inapplicable.
-
-The following modules will be removed from the core distribution in a
-future release, and will at that time need to be installed from CPAN.
-Distributions on CPAN which require these modules will need to list them as
-prerequisites.
-
-The core versions of these modules will now issue C<"deprecated">-category
-warnings to alert you to this fact.  To silence these deprecation warnings,
-install the modules in question from CPAN.
+=head2 Avoid possible read of free()d memory during parsing
 
-Note that these are (with rare exceptions) fine modules that you are encouraged
-to continue to use.  Their disinclusion from core primarily hinges on their
-necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
-not usually on concerns over their design.
-
-=over
-
-XXX Note that deprecated modules should be listed here even if they are listed
-as an updated module in the L</Modules and Pragmata> section.
-
-=back
-
-[ List each other deprecation as a =head2 entry ]
+It was possible that free()d memory could be read during parsing in the unusual
+circumstance of the Perl program ending with a heredoc and the last line of the
+file on disk having no terminating newline character.  This has now been fixed.
 
 =head1 Performance Enhancements
 
-XXX Changes which enhance performance without changing behaviour go here.
-There may well be none in a stable release.
-
-[ List each enhancement as a =item entry ]
-
 =over 4
 
 =item *
 
-XXX
+A performance regression introduced in Perl 5.11.2 in non-Unicode
+case-insensitive pattern matching has been largely resolved.  In particular,
+the disabled optimization is now restored for every ASCII-range character.
+[perl #107816]
 
 =back
 
 =head1 Modules and Pragmata
 
-XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
-go here.  If Module::CoreList is updated, generate an initial draft of the
-following sections using F<Porting/corelist-perldelta.pl>, which prints stub
-entries to STDOUT.  Results can be pasted in place of the '=head2' entries
-below.  A paragraph summary for important changes should then be added by hand.
-In an ideal world, dual-life modules would have a F<Changes> file that could be
-cribbed.
-
-[ Within each section, list entries as a =item entry ]
-
-=head2 New Modules and Pragmata
-
-=over 4
-
-=item *
-
-XXX
-
-=back
-
 =head2 Updated Modules and Pragmata
 
 =over 4
@@ -146,7 +61,7 @@ Added the C<NAME_HEK> method to return the name of a lexical sub.
 
 =item *
 
-L<bignum> has been upgraded from version 0.35 to 0.36.
+L<bignum> has been upgraded from version 0.33 to 0.36.
 
 L<bigrat> wasn't correctly updating an internal variable when C<use>d with a
 C<lib> option.
@@ -164,19 +79,20 @@ C<CARP_TRACE> as well as other references. [perl #92446]
 
 L<Compress::Raw::Bzip2> has been upgraded from 2.061 to 2.062.
 
-XXX: TODO
+No changes have been made other than the version bump to keep in sync with
+other related modules.
 
 =item *
 
 L<Compress::Raw::Zlib> has been upgraded from 2.061 to 2.062.
 
-XXX: TODO
+A minor typo has been fixed in the documentation.
 
 =item *
 
 L<Config::Perl::V> has been upgraded from version 0.18 to 0.19.
 
-XXX: TODO
+The list of build options has been updated.
 
 =item *
 
@@ -252,12 +168,6 @@ L<Exporter> would ignore custom $SIG{__WARN__} handlers in C<Exporter::Heavy>.
 
 =item *
 
-L<File::Spec> has been upgraded from 3.41 to 3.44.
-
-The module is now partly implemented in XS, for performance.
-
-=item *
-
 L<ExtUtils::MakeMaker> has been upgraded from 6.68 to 6.72.
 
 The C<dist> target now reports the file created, an infinite loop in
@@ -269,9 +179,9 @@ control characters are now stripped from C<ABSTRACT>.
 
 =item *
 
-L<ExtUtils::ParseXS> has been upgraded from version 3.18 to 3.21.
+L<File::Spec> has been upgraded from 3.41 to 3.44.
 
-XXX: TODO
+The module is now partly implemented in XS, for performance.
 
 =item *
 
@@ -284,7 +194,7 @@ but fails to be provided with one.
 
 The IO-Compress module collection has been upgraded from 2.061 to 2.062.
 
-XXX: TODO
+Some documentation typos have been fixed.
 
 =item *
 
@@ -310,7 +220,8 @@ $EXPORT_TAGS{all} has been added and a couple of typos have been fixed.
 
 The libnet module collection has been upgraded from version 1.22 to 1.23.
 
-XXX: TODO
+Numerous bug fixes and documentation improvements have been made.  See the
+F<Changes> file for full details.
 
 =item *
 
@@ -331,7 +242,7 @@ been enhanced and hash argument parsing in subclasses has been fixed.
 
 L<Module::CoreList> has been upgraded from 2.92 to 2.97.
 
-XXX: TODO
+The list of Perl versions covered has been updated.
 
 =item *
 
@@ -343,7 +254,7 @@ A minor typo has been fixed in the documentation.
 
 L<parent> has been upgraded from version 0.225 to 0.226.
 
-XXX: TODO
+Internal changes only have been made to the test suite.
 
 =item *
 
@@ -374,47 +285,29 @@ Avoid creating temporary objects for STORABLE_attach when they aren't required.
 
 =item *
 
-L<Time::Piece> has been upgraded from version 1.21 to 1.22.
-
-XXX: TODO
+L<Time::HiRes> has been upgraded from version 1.9725 to 1.9726.
 
-=item 8
-
-L<utf8> has been upgraded from version 1.12 to 1.13.
-
-A minor clarification has been made in the documentation.
+An C<lstat> function is now provided and various bugs have been fixed.  See the
+F<Changes> file for full details.
 
-=back
+=item *
 
-=head2 Removed Modules and Pragmata
+L<Time::Piece> has been upgraded from version 1.21 to 1.22.
 
-=over 4
+A minor documentation encoding problem has been fixed.
 
 =item *
 
-XXX
+L<utf8> has been upgraded from version 1.12 to 1.13.
+
+A minor clarification has been made in the documentation.
 
 =back
 
 =head1 Documentation
 
-XXX Changes to files in F<pod/> go here.  Consider grouping entries by
-file and be sure to link to the appropriate page, e.g. L<perlfunc>.
-
-=head2 New Documentation
-
-XXX Changes which create B<new> files in F<pod/> go here.
-
-=head3 L<XXX>
-
-XXX Description of the purpose of the new file here
-
 =head2 Changes to Existing Documentation
 
-XXX Changes which significantly change existing files in F<pod/> go here.
-However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
-section.
-
 =head3 L<perlopentut>
 
 =over 4
@@ -442,6 +335,17 @@ The C</r> modifier (for non-destructive substitution) is now documented. [perl
 
 =back
 
+=head3 L<perlsub>
+
+=over 4
+
+=item *
+
+The need to predeclare recursive functions with prototypes in order for the
+prototype to be honoured in the recursive call is now documented. [perl #2726]
+
+=back
+
 =head3 L<perlxs>
 
 =over 4
@@ -458,21 +362,20 @@ The following additions or changes have been made to diagnostic output,
 including warnings and fatal error messages.  For the complete list of
 diagnostic messages, see L<perldiag>.
 
-XXX New or changed warnings emitted by the core's C<C> code go here.  Also
-include any changes in L<perldiag> that reconcile it to the C<C> code.
-
 =head2 New Diagnostics
 
-XXX Newly added diagnostic messages go under here, separated into New Errors
-and New Warnings
-
 =head3 New Errors
 
 =over 4
 
 =item *
 
-XXX L<message|perldiag/"message">
+L<Magical list constants are not supported|perldiag/"Magical list constants are
+not supported">
+
+(F) You assigned a magical array to a stash element, and then tried to use the
+subroutine from the same slot.  You are asking Perl to do something it cannot
+do, details subject to change between Perl versions.
 
 =back
 
@@ -489,131 +392,45 @@ as 0 in increment (++)">
 which expects either a number or a string matching C</^[a-zA-Z]*[0-9]*\z/>.
 See L<perlop/Auto-increment and Auto-decrement> for details.
 
-=back
-
-=head2 Changes to Existing Diagnostics
-
-XXX Changes (i.e. rewording) of diagnostic messages go here
-
-=over 4
-
 =item *
 
-XXX Describe change here
-
-=back
-
-=head1 Utility Changes
-
-XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
-Most of these are built within the directories F<utils> and F<x2p>.
+L<Unexpected exit %u|perldiag/"Unexpected exit %u">
 
-[ List utility changes as a =head3 entry for each utility and =item
-entries for each change
-Use L<XXX> with program names to get proper documentation linking. ]
-
-=head3 L<XXX>
-
-=over 4
+(S) exit() was called or the script otherwise finished gracefully when
+C<PERL_EXIT_WARN> was set in C<PL_exit_flags>.
 
 =item *
 
-XXX
-
-=back
+L<Unexpected exit failure %u|perldiag/"Unexpected exit failure %u">
 
-=head1 Configuration and Compilation
-
-XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
-go here.  Any other changes to the Perl build process should be listed here.
-However, any platform-specific changes should be listed in the
-L</Platform Support> section, instead.
-
-[ List changes as a =item entry ].
-
-=over 4
-
-=item *
-
-XXX
+(S) An uncaught die() was called when C<PERL_EXIT_WARN> was set in
+C<PL_exit_flags>.
 
 =back
 
 =head1 Testing
 
-XXX Any significant changes to the testing of a freshly built perl should be
-listed here.  Changes which create B<new> files in F<t/> go here as do any
-large changes to the testing harness (e.g. when parallel testing was added).
-Changes to existing files in F<t/> aren't worth summarizing, although the bugs
-that they represent may be covered elsewhere.
-
-[ List each test improvement as a =item entry ]
-
 =over 4
 
 =item *
 
-XXX
-
-=back
-
-=head1 Platform Support
+The behaviour of C<pos> on very large strings is now tested in the new test
+script F<t/bigmem/pos.t>.
 
-XXX Any changes to platform support should be listed in the sections below.
-
-[ Within the sections, list each platform as a =item entry with specific
-changes as paragraphs below it. ]
-
-=head2 New Platforms
-
-XXX List any platforms that this version of perl compiles on, that previous
-versions did not.  These will either be enabled by new files in the F<hints/>
-directories, or new subdirectories and F<README> files at the top level of the
-source tree.
-
-=over 4
-
-=item XXX-some-platform
-
-XXX
-
-=back
-
-=head2 Discontinued Platforms
-
-XXX List any platforms that this version of perl no longer compiles on.
-
-=over 4
-
-=item XXX-some-platform
-
-XXX
-
-=back
-
-=head2 Platform-Specific Notes
+=item *
 
-XXX List any changes for specific platforms.  This could include configuration
-and compilation changes or changes in portability/compatibility.  However,
-changes within modules for platforms should generally be listed in the
-L</Modules and Pragmata> section.
+The test script F<t/porting/ss_dup.t> has been created to test that ss_dup()
+handles all savestack items.
 
-=over 4
-
-=item XXX-some-platform
+=item *
 
-XXX
+The new behaviour of B<-F> and B<-a> (see the L</Core Enhancements> section) is
+tested in the new test script F<t/run/switchF2.t>.
 
 =back
 
 =head1 Internal Changes
 
-XXX Changes which affect the interface available to C<XS> code go here.  Other
-significant internal changes for future core maintainers should be noted as
-well.
-
-[ List each change as a =item entry ]
-
 =over 4
 
 =item *
@@ -630,11 +447,6 @@ perl C<warn> or C<abort> on an attempted exit. [perl #52000]
 
 =head1 Selected Bug Fixes
 
-XXX Important bug fixes in the core language are summarized here.  Bug fixes in
-files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
-
-[ List each fix as a =item entry ]
-
 =over 4
 
 =item *
@@ -694,7 +506,7 @@ fixed. [perl #118213]
 
 =item *
 
-Starting in v5.18.0, a construct like C</[#](?{})/x> would have its C<#>
+Starting in Perl 5.18.0, a construct like C</[#](?{})/x> would have its C<#>
 incorrectly interpreted as a comment.  The code block would be skipped,
 unparsed.  This has been corrected.
 
@@ -774,7 +586,7 @@ C<reset> with an argument now skips scalars aliased to typeglobs
 =item *
 
 C<ucfirst> and C<lcfirst> were not respecting the bytes pragma.  This was a
-regression from v5.12. [perl #117355]
+regression from Perl 5.12. [perl #117355]
 
 =item *
 
@@ -787,31 +599,22 @@ problematic).
 Where a regular expression included code blocks (C</(?{...})/>), and where the
 use of constant overloading triggered a re-compilation of the code block, the
 second compilation didn't see its outer lexical scope.  This was a regression
-in 5.18.0.
+in Perl 5.18.0.
 
-=back
-
-=head1 Known Problems
-
-XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
-tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
-platform specific bugs also go here.
-
-[ List each fix as a =item entry ]
+=item *
 
-=over 4
+Changes to C<UNIVERSAL::DESTROY> now update DESTROY caches in all classes,
+instead of causing classes that have already had objects destroyed to
+continue using the old sub.  This was a regression in Perl 5.18. [perl #114864]
 
 =item *
 
-XXX
+All known false-positive occurrences of the deprecation warning "Useless use of
+'\'; doesn't escape metacharacter '%c'", added in Perl 5.18.0, have been
+removed. [perl #119101]
 
 =back
 
-=head1 Obituary
-
-XXX If any significant core contributor has died, we've added a short obituary
-here.
-
 =head1 Acknowledgements
 
 XXX Generate this with: