This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Finalize perldelta
[perl5.git] / pod / perldelta.pod
index 2fa34c7..6a57a01 100644 (file)
 
 =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.31.2
+perldelta - what is new for perl v5.31.5
 
 =head1 DESCRIPTION
 
-This document describes differences between the 5.31.1 release and the 5.31.2
+This document describes differences between the 5.31.4 release and the 5.31.5
 release.
 
-If you are upgrading from an earlier release such as 5.31.0, first read
-L<perl5311delta>, which describes differences between 5.31.0 and 5.31.1.
-
-=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 ]
-
-=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 ]
+If you are upgrading from an earlier release such as 5.31.3, first read
+L<perl5314delta>, which describes differences between 5.31.3 and 5.31.4.
 
 =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.
+=head2 Modifiable variables are no longer permitted in constants
 
-[ List each incompatible change as a =head2 entry ]
+Code like:
 
-=head1 Deprecations
+    my $var;
+    $sub = sub () { $var };
 
-XXX Any deprecated features, syntax, modules etc. should be listed here.
+where C<$var> is referenced elsewhere in some sort of modifiable context now
+produces an exception when the sub is defined.
 
-=head2 Module removals
+This error can be avoided by adding a return to the sub definition:
 
-XXX Remove this section if not applicable.
+    $sub = sub () { return $var };
 
-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.
+This has been deprecated since Perl 5.22.
 
-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.
+L<[perl #131138]|https://rt.perl.org/Ticket/Display.html?id=131138>.
 
-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
+=head1 Modules and Pragmata
 
-=item XXX
+=head2 Updated Modules and Pragmata
 
-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.
+=over 4
 
-=back
+=item *
 
-[ List each other deprecation as a =head2 entry ]
+L<B> has been upgraded from version 1.76 to 1.77.
 
-=head1 Performance Enhancements
+=item *
 
-XXX Changes which enhance performance without changing behaviour go here.
-There may well be none in a stable release.
+L<B::Deparse> has been upgraded from version 1.49 to 1.50.
 
-[ List each enhancement as an =item entry ]
+=item *
 
-=over 4
+L<Devel::PPPort> has been upgraded from version 3.55 to 3.54.
 
 =item *
 
-XXX
+L<Digest::MD5> has been upgraded from version 2.55 to 2.55_01.
 
-=back
+=item *
 
-=head1 Modules and Pragmata
+L<Dumpvalue> has been upgraded from version 1.18 to 1.21.
 
-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>.  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.
+Previously, when dumping elements of an array and encountering an undefined
+value, the string printed would have been C<empty array>.  This has been
+changed to what was apparently originally intended:  C<empty slot>.
 
-The list of new and updated modules is modified automatically as part of
-preparing a Perl release, so the only reason to manually add entries here is if
-you're summarising the important changes in the module update. (Also, if the
-manually-added details don't match the automatically-generated ones, the
-release manager will have to investigate the situation carefully.)
+=item *
 
-[ Within each section, list entries as an =item entry ]
+L<ExtUtils::CBuilder> has been upgraded from version 0.280232 to 0.280233.
 
-=head2 New Modules and Pragmata
+=item *
 
-=over 4
+L<Math::BigInt> has been upgraded from version 1.999816 to 1.999817_01.
 
 =item *
 
-XXX Remove this section if not applicable.
-
-=back
+L<Math::BigInt::FastCalc> has been upgraded from version 0.5008 to 0.5009.
 
-=head2 Updated Modules and Pragmata
+=item *
 
-=over 4
+L<Module::CoreList> has been upgraded from version 5.20190920 to 5.20191020.
 
 =item *
 
-L<XXX> has been upgraded from version A.xx to B.yy.
+L<Safe> has been upgraded from version 2.40 to 2.41.
 
-If there was something important to note about this change, include that here.
+=item *
 
-=back
+L<threads> has been upgraded from version 2.22 to 2.23.
 
-=head2 Removed Modules and Pragmata
+=item *
 
-=over 4
+L<Time::HiRes> has been upgraded from version 1.9763 to 1.9764.
 
 =item *
 
-XXX
+L<XS::APItest> has been upgraded from version 1.03 to 1.04.
 
 =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
 
-We have attempted to update the documentation to reflect the changes
-listed in this document.  If you find any we have missed, send email
-to L<perlbug@perl.org|mailto:perlbug@perl.org>.
-
-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.
+We have attempted to update the documentation to reflect the changes listed in
+this document.  If you find any we have missed, send email to
+L<perlbug@perl.org|mailto:perlbug@perl.org>.
 
-Additionally, the following selected changes have been made:
-
-=head3 L<XXX>
+=head3 L<perlguts>
 
 =over 4
 
 =item *
 
-XXX Description of the change here
+Details of the various stacks within the perl interpreter are now explained
+here.
 
 =back
 
-=head1 Diagnostics
-
-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
+Additionally, the following selected changes have been made:
 
-=head3 New Errors
+=head3 URLs have been changed to https:// and stale links have been updated
 
 =over 4
 
 =item *
 
-XXX L<message|perldiag/"message">
-
-=back
-
-=head3 New Warnings
-
-=over 4
+Where applicable, the URLs in the documentation have been moved from using the
+http:// protocol to https:// .  This also affects the location of the bug
+tracker at L<https://rt.perl.org>.
 
 =item *
 
-XXX L<message|perldiag/"message">
-
-=back
-
-=head2 Changes to Existing Diagnostics
-
-XXX Changes (i.e. rewording) of diagnostic messages go here
-
-=over 4
+Some links to OS/2 libraries, Address Sanitizer and other system tools had gone
+stale.  These have been updated with working links.
 
 =item *
 
-XXX Describe change here
+Some links to old mails on perl5-porters had gone stale.  These have been
+updated with working links.
 
 =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 directory F<utils>.
+=head1 Diagnostics
 
-[ List utility changes as a =head2 entry for each utility and =item
-entries for each change
-Use L<XXX> with program names to get proper documentation linking. ]
+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>.
 
-=head2 L<XXX>
+=head2 Changes to Existing Diagnostics
 
 =over 4
 
 =item *
 
-XXX
-
-=back
-
-=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.
+L<Can't use global %s in %s|perldiag/"Can't use global %s in %s">
 
-[ List changes as an =item entry ].
-
-=over 4
+This error message has been slightly reformatted from the original C<Can't use
+global %s in "%s">, and in particular misleading error messages like C<Can't
+use global $_ in "my"> are now rendered as C<Can't use global $_ in subroutine
+signature>.
 
 =item *
 
-XXX
-
-=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.
-
-XXX If there were no significant test changes, say this:
+L<Constants from lexical variables potentially modified elsewhere are no longer permitted|perldiag/"Constants from lexical variables potentially modified elsewhere are no longer permitted">
 
-Tests were added and changed to reflect the other additions and changes
-in this release.
+This error message replaces the former C<Constants from lexical variables
+potentially modified elsewhere are deprecated.  This will not be allowed in Perl
+5.32> to reflect the fact that this previously deprecated usage has now been
+transformed into an exception.  The message's classification has also been
+updated from D (deprecated) to F (fatal).
 
-XXX If instead there were significant changes, say this:
+See also L</Incompatible Changes>.
 
-Tests were added and changed to reflect the other additions and
-changes in this release.  Furthermore, these significant changes were
-made:
+=back
 
-[ List each test improvement as an =item entry ]
+=head1 Configuration and Compilation
 
 =over 4
 
 =item *
 
-XXX
-
-=back
-
-=head1 Platform Support
-
-XXX Any changes to platform support should be listed in the sections below.
-
-[ Within the sections, list each platform as an =item entry with specific
-changes as paragraphs below it. ]
+Perl now no longer probes for C<d_u32align>, defaulting to C<define> on all
+platforms.  This check was error prone when it was done, which was on 32-bit
+platforms only.
+L<[perl #133495]|https://rt.perl.org/Ticket/Display.html?id=133495>.
 
-=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.
+=item *
 
-=over 4
+Documentation and hints for building perl on Z/OS (native EBCDIC) have been
+updated.  Still work in progress.
 
-=item XXX-some-platform
+=item *
 
-XXX
+A new probe for C<malloc_usable_size> has been added.
 
 =back
 
-=head2 Discontinued Platforms
-
-XXX List any platforms that this version of perl no longer compiles on.
-
-=over 4
-
-=item XXX-some-platform
+=head1 Testing
 
-XXX
+Tests were added and changed to reflect the other additions and changes in this
+release.
 
-=back
+=head1 Platform Support
 
 =head2 Platform-Specific Notes
 
-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.
-
 =over 4
 
-=item XXX-some-platform
-
-XXX
-
-=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 an =item entry ]
+=item Windows
 
 =over 4
 
 =item *
 
-XXX
-
-=back
-
-=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 an =item entry ]
-
-=over 4
+Support for building perl with Visual C++ 6.0 has now been removed.
 
 =item *
 
-XXX
+Building perl with Visual C++ 2013 and earlier was broken in the previous
+release but has now been fixed.
 
 =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.
+=back
 
-[ List each fix as an =item entry ]
+=head1 Internal Changes
 
 =over 4
 
 =item *
 
-XXX
+Added the C<<PL_curstackinfo->si_cxsubix>> field.  This records the stack index
+of the most recently pushed sub/format/eval context.  It is set and restored
+automatically by C<cx_pushsub()>, C<cx_popsub()> etc., but would need to be
+manually managed if you do any unusual manipulation of the context stack.
 
-=back
+=item *
 
-=head1 Errata From Previous Releases
+Various macros dealing with character type classification and changing case
+where the input is encoded in UTF-8 now require an extra parameter to prevent
+potential reads beyond the end of the buffer.  Use of these has generated a
+deprecation warning since Perl 5.26.  Details are in
+L<perldeprecation/In XS code, use of various macros dealing with UTF-8.>
 
-=over 4
+=back
 
-=item *
+=head1 Acknowledgements
 
-XXX Add anything here that we forgot to add, or were mistaken about, in
-the perldelta of a previous release.
+Perl 5.31.5 represents approximately 4 weeks of development since Perl 5.31.4
+and contains approximately 27,000 lines of changes across 610 files from 15
+authors.
 
-=back
+Excluding auto-generated files, documentation and release tools, there were
+approximately 9,500 lines of changes to 150 .pm, .t, .c and .h files.
 
-=head1 Obituary
+Perl continues to flourish into its fourth decade thanks to a vibrant community
+of users and developers.  The following people are known to have contributed
+the improvements that became Perl 5.31.5:
 
-XXX If any significant core contributor or member of the CPAN community has
-died, add a short obituary here.
+Dagfinn Ilmari MannsÃ¥ker, David Mitchell, H.Merijn Brand, James E Keenan, Karl
+Williamson, Matt Turner, Max Maischein, Nicolas R., Pali, Paul Evans, Paul
+Marquess, Peter Eisentraut, Steve Hay, Tomasz Konojacki, Tony Cook.
 
-=head1 Acknowledgements
+The list above is almost certainly incomplete as it is automatically generated
+from version control history.  In particular, it does not include the names of
+the (very much appreciated) contributors who reported issues to the Perl bug
+tracker.
 
-XXX Generate this with:
+Many of the changes included in this version originated in the CPAN modules
+included in Perl's core.  We're grateful to the entire CPAN community for
+helping Perl to flourish.
 
-  perl Porting/acknowledgements.pl v5.31.1..HEAD
+For a more complete list of all of Perl's historical contributors, please see
+the F<AUTHORS> file in the Perl source distribution.
 
 =head1 Reporting Bugs
 
-If you find what you think is a bug, you might check the perl bug database
-at L<https://rt.perl.org/>.  There may also be information at
-L<http://www.perl.org/>, the Perl Home Page.
+If you find what you think is a bug, you might check the perl bug database at
+L<https://rt.perl.org/>.  There may also be information at
+L<https://www.perl.org/>, the Perl Home Page.
 
 If you believe you have an unreported bug, please run the L<perlbug> program
 included with your release.  Be sure to trim your bug down to a tiny but
@@ -418,13 +285,13 @@ will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
 
 If the bug you are reporting has security implications which make it
 inappropriate to send to a publicly archived mailing list, then see
-L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
-for details of how to report the issue.
+L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION> for details of how to
+report the issue.
 
 =head1 Give Thanks
 
-If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
-you can do so by running the C<perlthanks> program:
+If you wish to thank the Perl 5 Porters for the work we had done in Perl 5, you
+can do so by running the C<perlthanks> program:
 
     perlthanks