This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for 0f4fe36327e6, 1768639d6db2
[perl5.git] / pod / perldelta.pod
index 6bed9ab..1541525 100644 (file)
 
 =head1 NAME
 
-perldelta - what is new for perl v5.29.8
+[ 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.1
 
 =head1 DESCRIPTION
 
-This document describes differences between the 5.29.7 release and the 5.29.8
+This document describes differences between the 5.31.0 release and the 5.31.1
 release.
 
-If you are upgrading from an earlier release such as 5.29.6, first read
-L<perl5297delta>, which describes differences between 5.29.6 and 5.29.7.
+If you are upgrading from an earlier release such as 5.30.0, first read
+L<perl5310delta>, which describes differences between 5.30.0 and 5.31.0.
 
 =head1 Notice
 
-sv_utf8_(downgrade|decode) are no longer marked as experimental [perl #133788]
+XXX Any important notices here
 
 =head1 Core Enhancements
 
-=head2 Use faster method to convert to UTF-8
-
-There is a special inline function that's used when converting a single
-byte to UTF-8, that is faster than the more general one used prior to
-this commit.
+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.
 
-=head2 Turkic UTF-8 locales are now seamlessly supported
+[ List each enhancement as a =head2 entry ]
 
-Turkic languages have different casing rules than other languages for
-the characters C<"i"> and C<"I">.  The uppercase of C<"i"> is LATIN
-CAPITAL LETTER I WITH DOT ABOVE (U+0130); and the lowercase of C<"I"> is LATIN
-SMALL LETTER DOTLESS I (U+0131).  Unicode furnishes alternate casing
-rules for use with Turkic languages.  Previously, Perl ignored these,
-but now, it uses them when it detects that it is operating under a
-Turkic UTF-8 locale.
+=head1 Security
 
-=head2 Eliminate opASSIGN macro usage from core
+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.
 
-This macro is still defined but no longer used in core
+[ List each security issue as a =head2 entry ]
 
 =head1 Incompatible Changes
 
-=head2 JSON::PP enable allow_nonref by default
+XXX For a release on a stable branch, this section aspires to be:
 
-As JSON::XS 4.0 changed its policy and enabled allow_nonref
-by default, JSON::PP also enabled allow_nonref by default.
+    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.
 
-=head1 Performance Enhancements
+[ List each incompatible change as a =head2 entry ]
 
-=over 4
+=head1 Deprecations
+
+XXX Any deprecated features, syntax, modules etc. should be listed here.
+
+=head2 Module removals
+
+XXX Remove this section if not applicable.
 
-Eliminate recursion from finalize_op() [perl #108276]
+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.
+
+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
+
+=item XXX
+
+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
 
-=head1 Modules and Pragmata
+[ List each other deprecation as a =head2 entry ]
 
-=head2 Updated Modules and Pragmata
+=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 an =item entry ]
 
 =over 4
 
 =item *
 
-L<B> has been upgraded from version 1.75 to 1.76.
+XXX
 
-=item *
+=back
 
-L<Encode> has been upgraded from version 2.97 to 3.00.
+=head1 Modules and Pragmata
 
-=item *
+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.
 
-L<JSON::PP> has been upgraded from version 2.97001 to 4.00.
-JSON::PP as JSON::XS 4.0 enable allow_nonref by default
+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<Module::CoreList> has been upgraded from version 5.20190120 to 5.20190220.
+=head2 New Modules and Pragmata
 
-Changes to B::Op_private and Config
+=over 4
 
 =item *
 
-L<Module::Load> has been upgraded from version 0.32 to 0.34.
+XXX Remove this section if not applicable.
 
-=item *
+=back
 
-L<Net::Ping> has been upgraded from version 2.61 to 2.71.
+=head2 Updated Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<perlfaq> has been upgraded from version 5.20180915 to 5.20190126.
+L<XXX> has been upgraded from version A.xx to B.yy.
 
-=item *
+If there was something important to note about this change, include that here.
 
-L<Test::Simple> has been upgraded from version 1.302160 to 1.302162.
+=back
+
+=head2 Removed Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<XS::APItest> has been upgraded from version 0.99 to 1.00.
+Pod::Parser has been removed from the core distribution.
+It still is available for download from CPAN.  This resolves [perl
+#119439].
 
 =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.
+
 Additionally, the following selected changes have been made:
 
-=head3 L<perlfunc>
+=head3 L<XXX>
 
 =over 4
 
 =item *
 
-Try to clarify that C<< ref(qr/xx/) >> returns C<Regexp> rather than
-C<REGEXP> and why.  [perl #133751]
+XXX Description of the change here
 
 =back
 
-=head3 L<perllocale>
+=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
+
+=head3 New Errors
 
 =over 4
 
 =item *
 
-There are actually two slightly different types of UTF-8 locales: one for Turkic
-languages and one for everything else. Starting in Perl v5.30, Perl seamlessly 
-handles both types.
+XXX L<message|perldiag/"message">
 
 =back
 
-=head3 L<perlrecharclass>
+=head3 New Warnings
 
 =over 4
 
 =item *
 
-Add a note for the ::xdigit:: character class.
+XXX L<message|perldiag/"message">
 
 =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>.
-
 =head2 Changes to Existing Diagnostics
 
+XXX Changes (i.e. rewording) of diagnostic messages go here
+
 =over 4
 
 =item *
 
-L<Type of arg %d to %s must be %s (not %s)|perldiag/"Type of arg %d to %s must be %s (not %s)">
-
-Attempts to push, pop, etc on a hash or glob now produce this message
-rather than complaining that they no longer work on scalars. [perl
-#130367]
+XXX Describe change here
 
 =back
 
-=head1 Configuration and Compilation
+=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>.
+
+[ 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. ]
+
+=head2 L<XXX>
 
 =over 4
 
 =item *
 
-Improve detection of memrchr, strlcat, and strlcpy
+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.
+
+[ List changes as an =item entry ].
+
+=over 4
 
 =item *
 
-Improve Configure detection of memmem() [perl #133760].
+XXX
 
 =back
 
@@ -202,19 +285,7 @@ made:
 
 =item *
 
-t/lib/croak/op [perl #130367]
-
-separate error for push etc on hash/glob
-
-=item *
-
-t/op/svleak.t [perl #133660]
-
-add test for goto &sub in overload leaking
-
-=item *
-
-Split t/re/fold_grind.t into multiple test files
+XXX
 
 =back
 
@@ -279,7 +350,8 @@ well.
 
 =item *
 
-XXX
+L<eval_pv()|perlapi/eval_pv> no longer stringifies the exception when
+C<croak_on_error> is true.  [perl #134175]
 
 =back
 
@@ -294,35 +366,68 @@ files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
 
 =item *
 
-Regular expression matching no longer leaves stale UTF-8 length magic
-when updating C<$^R>. This could result in C<length($^R)> returning
-an incorrect value.
+close() on a pipe now preemptively clears the PerlIO object from the
+IO SV.  This prevents a second attempt to close the already closed
+PerlIO object if a signal handler calls die() or exit() while close()
+is waiting for the child process to complete.  [perl #122112]
 
 =item *
 
-Fix a qr/[...]/ bug introduced in v5.29.7
+C<< sprintf("%.*a", -10000, $x) >> would cause a buffer overflow due
+to mishandling of the negative precision value.  [perl #134008]
+
+=item *
 
-Using /il should not result in looking for a [:posix:] class
-that matches the code points given.
+scalar() on a reference could cause an erroneous assertion failure
+during compilation.  [perl #134045]
 
 =item *
 
-Reduce recursion on ops [perl #108276]
+Extraordinarily large (over 2GB) floating point format widths could
+cause an integer overflow in the underlying call to snprintf(),
+resulting in an assertion.  Formatted floating point widths are now
+limited to the range of int, the return value of snprintf().  [perl
+#133913]
 
-This can prevent stack overflow when processing extremely deep op
-trees.
+=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 an =item entry ]
+
+=over 4
+
+=item *
+
+XXX
+
+=back
+
+=head1 Errata From Previous Releases
+
+=over 4
 
 =item *
 
-Avoid leak in multiconcat with overloading. [perl #133789]
+XXX Add anything here that we forgot to add, or were mistaken about, in
+the perldelta of a previous release.
 
 =back
 
+=head1 Obituary
+
+XXX If any significant core contributor or member of the CPAN community has
+died, add a short obituary here.
+
 =head1 Acknowledgements
 
 XXX Generate this with:
 
-  perl Porting/acknowledgements.pl v5.29.7..HEAD
+  perl Porting/acknowledgements.pl v5.31.0..HEAD
 
 =head1 Reporting Bugs