This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
generate new perldelta
authorKaren Etheridge <ether@cpan.org>
Thu, 20 Jun 2019 20:43:11 +0000 (13:43 -0700)
committerKaren Etheridge <ether@cpan.org>
Thu, 20 Jun 2019 20:43:11 +0000 (13:43 -0700)
MANIFEST
Makefile.SH
pod/.gitignore
pod/perl.pod
pod/perl5311delta.pod [new file with mode: 0644]
pod/perldelta.pod
vms/descrip_mms.template
win32/GNUmakefile
win32/Makefile
win32/makefile.mk
win32/pod.mak

index d0300c8..8e90f03 100644 (file)
--- a/MANIFEST
+++ b/MANIFEST
@@ -4996,6 +4996,7 @@ pod/perl5281delta.pod             Perl changes in version 5.28.1
 pod/perl5282delta.pod          Perl changes in version 5.28.2
 pod/perl5300delta.pod          Perl changes in version 5.30.0
 pod/perl5310delta.pod          Perl changes in version 5.31.0
+pod/perl5311delta.pod          Perl changes in version 5.31.1
 pod/perl561delta.pod           Perl changes in version 5.6.1
 pod/perl56delta.pod            Perl changes in version 5.6
 pod/perl581delta.pod           Perl changes in version 5.8.1
index 73c9d81..bd8ac8f 100755 (executable)
@@ -588,7 +588,7 @@ esac
 
 $spitshell >>$Makefile <<'!NO!SUBS!'
 
-perltoc_pod_prereqs = extra.pods pod/perl5311delta.pod pod/perlapi.pod pod/perlintern.pod pod/perlmodlib.pod pod/perluniprops.pod
+perltoc_pod_prereqs = extra.pods pod/perl5312delta.pod pod/perlapi.pod pod/perlintern.pod pod/perlmodlib.pod pod/perluniprops.pod
 generated_pods = pod/perltoc.pod $(perltoc_pod_prereqs)
 generated_headers = uudmap.h bitcount.h mg_data.h
 
@@ -1152,9 +1152,9 @@ pod/perlintern.pod: $(MINIPERL_EXE) autodoc.pl embed.fnc
 pod/perlmodlib.pod: $(MINIPERL_EXE) pod/perlmodlib.PL MANIFEST
        $(MINIPERL) pod/perlmodlib.PL -q
 
-pod/perl5311delta.pod: pod/perldelta.pod
-       $(RMS) pod/perl5311delta.pod
-       $(LNS) perldelta.pod pod/perl5311delta.pod
+pod/perl5312delta.pod: pod/perldelta.pod
+       $(RMS) pod/perl5312delta.pod
+       $(LNS) perldelta.pod pod/perl5312delta.pod
 
 extra.pods: $(MINIPERL_EXE)
        -@test ! -f extra.pods || rm -f `cat extra.pods`
index c6e3d63..07a99d3 100644 (file)
@@ -49,7 +49,7 @@
 /roffitall
 
 # generated
-/perl5311delta.pod
+/perl5312delta.pod
 /perlapi.pod
 /perlintern.pod
 /perlmodlib.pod
index dcf717d..6e6ae58 100644 (file)
@@ -181,6 +181,7 @@ aux h2ph h2xs perlbug pl2pm pod2html pod2man splain xsubpp
 
     perlhist           Perl history records
     perldelta          Perl changes since previous version
+    perl5311delta      Perl changes in version 5.31.1
     perl5310delta      Perl changes in version 5.31.0
     perl5300delta      Perl changes in version 5.30.0
     perl5282delta      Perl changes in version 5.28.2
diff --git a/pod/perl5311delta.pod b/pod/perl5311delta.pod
new file mode 100644 (file)
index 0000000..eb29fb6
--- /dev/null
@@ -0,0 +1,418 @@
+=encoding utf8
+
+=head1 NAME
+
+perl5311delta - what is new for perl v5.31.1
+
+=head1 DESCRIPTION
+
+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.30.0, first read
+L<perl5310delta>, which describes differences between 5.30.0 and 5.31.0.
+
+=head1 Incompatible Changes
+
+=head2 Use of L<C<vec>|perlfunc/vec EXPR,OFFSET,BITS> on strings with code points above 0xFF is forbidden
+
+Such strings are represented internally in UTF-8, and C<vec> is a
+bit-oriented operation that will likely give unexpected results on those
+strings.  This was deprecated in perl 5.28.0.
+
+=head2 Use of code points over 0xFF in string bitwise operators
+
+Some uses of these were already illegal after a previous deprecation
+cycle.  The remaining uses are now prohibited, having been deprecated in perl
+5.28.0.  See L<perldeprecation>.
+
+=head2 C<Sys::Hostname::hostname()> does not accept arguments
+
+This usage was deprecated in perl 5.28.0 and is now fatal.
+
+=head1 Modules and Pragmata
+
+=head2 Updated Modules and Pragmata
+
+=over 4
+
+=item *
+
+L<Class::Struct> has been upgraded from version 0.65 to 0.66.
+
+=item *
+
+L<Compress::Raw::Bzip2> has been upgraded from version 2.084 to 2.086.
+
+=item *
+
+L<Compress::Raw::Zlib> has been upgraded from version 2.084 to 2.086.
+
+=item *
+
+L<CPAN> has been upgraded from version 2.22 to 2.27.
+
+=item *
+
+L<DB_File> has been upgraded from version 1.843 to 1.852.
+
+=item *
+
+L<Devel::PPPort> has been upgraded from version 3.52 to 3.53.
+
+=item *
+
+L<ExtUtils::CBuilder> has been upgraded from version 0.280231 to 0.280232.
+
+=item *
+
+L<ExtUtils::MakeMaker> has been upgraded from version 7.34 to 7.36.
+
+=item *
+
+L<I18N::LangTags> has been upgraded from version 0.43 to 0.44.
+
+=item *
+
+L<IO> has been upgraded from version 1.40 to 1.41.
+
+The supplied I<TO> is now always honoured on calls to the send()
+method.  L<[perl #133936]|https://rt.perl.org/Ticket/Display.html?id=133936>
+
+=item *
+
+L<IO::Compress> has been upgraded from version 2.084 to 2.086.
+
+=item *
+
+L<Module::CoreList> has been upgraded from version 5.20190524 to 5.20190620.
+
+=item *
+
+L<overload> has been upgraded from version 1.30 to 1.31.
+
+=item *
+
+L<Pod::Simple> has been upgraded from version 3.36 to 3.38.
+
+=item *
+
+L<podlators> has been upgraded from version 4.11 to 4.12.
+
+=item *
+
+L<POSIX> has been upgraded from version 1.88 to 1.89.
+
+=item *
+
+L<SelfLoader> has been upgraded from version 1.25 to 1.26.
+
+=item *
+
+L<Storable> has been upgraded from version 3.15 to 3.16.
+
+Regular expressions objects weren't properly counted for object id
+purposes on retrieve.  This would corrupt the resulting structure, or
+cause a runtime error in some cases.  L<[perl #134179]|https://rt.perl.org/Ticket/Display.html?id=134179>
+
+=item *
+
+L<Sys::Hostname> has been upgraded from version 1.22 to 1.23.
+
+=item *
+
+L<Test::Simple> has been upgraded from version 1.302162 to 1.302164.
+
+=item *
+
+L<Tie::File> has been upgraded from version 1.02 to 1.03.
+
+=item *
+
+L<Tie::Hash::NamedCapture> has been upgraded from version 0.10 to 0.11.
+
+=item *
+
+L<Time::HiRes> has been upgraded from version 1.9760 to 1.9761.
+
+=item *
+
+L<Unicode::Normalize> has been upgraded from version 1.26 to 1.27.
+
+=item *
+
+L<Unicode::UCD> has been upgraded from version 0.72 to 0.73.
+
+=item *
+
+L<warnings> has been upgraded from version 1.44 to 1.45.
+
+=item *
+
+L<XS::APItest> has been upgraded from version 1.00 to 1.01.
+
+=back
+
+=head2 Removed Modules and Pragmata
+
+=over 4
+
+=item *
+
+Pod::Parser has been removed from the core distribution.
+It still is available for download from CPAN.  This resolves L<[perl
+#119439]|https://rt.perl.org/Ticket/Display.html?id=119439>.
+
+=back
+
+=head1 Documentation
+
+=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>.
+
+Additionally, the following selected changes have been made:
+
+=head3 L<perlguts>
+
+=over 4
+
+=item *
+
+Documentation about embed.fnc flags has been removed. F<embed.fnc> now has
+sufficient comments within it.  Anyone changing that file will see those
+comments first, so entries here are now redundant.
+
+=back
+
+=head3 L<perlpod>
+
+=over 4
+
+=item *
+
+Advice has been added regarding the usage of C<< ZE<lt>E<gt> >>.
+
+=back
+
+=head1 Configuration and Compilation
+
+=over 4
+
+=item *
+
+F<autodoc.pl>
+
+This tool that regenerates L<perlintern> and L<perlapi> has been overhauled
+significantly, restoring consistency in flags used in F<embed.fnc> and
+L<Devel::PPPort> and allowing removal of many redundant C<=for apidoc>
+entries in code.
+
+=back
+
+=head1 Platform Support
+
+=head2 Discontinued Platforms
+
+=over 4
+
+=item Windows CE
+
+Support for building perl on Windows CE has now been removed.
+
+=back
+
+=head1 Internal Changes
+
+=over 4
+
+=item *
+
+L<eval_pv()|perlapi/eval_pv> no longer stringifies the exception when
+C<croak_on_error> is true.  L<[perl #134175]|https://rt.perl.org/Ticket/Display.html?id=134175>
+
+=back
+
+=head1 Selected Bug Fixes
+
+=over 4
+
+=item *
+
+Setting C<$)> now properly sets supplementary group ids if you have
+the necessary privileges.  L<[perl #134169]|https://rt.perl.org/Ticket/Display.html?id=134169>
+
+=item *
+
+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.  L<[perl #122112]|https://rt.perl.org/Ticket/Display.html?id=122112>
+
+=item *
+
+C<< sprintf("%.*a", -10000, $x) >> would cause a buffer overflow due
+to mishandling of the negative precision value.  L<[perl #134008]|https://rt.perl.org/Ticket/Display.html?id=134008>
+
+=item *
+
+scalar() on a reference could cause an erroneous assertion failure
+during compilation.  L<[perl #134045]|https://rt.perl.org/Ticket/Display.html?id=134045>
+
+=item *
+
+C<%{^CAPTURE_ALL}> is now an alias to C<%-> as documented, rather than
+incorrectly an alias for C<%+>.  L<[perl #131867]|https://rt.perl.org/Ticket/Display.html?id=131867>
+
+=item *
+
+C<%{^CAPTURE}> didn't work if C<@{^CAPTURE}> was mentioned first.
+Similarly for C<%{^CAPTURE_ALL}> and C<@{^CAPTURE_ALL}>, though
+C<@{^CAPTURE_ALL}> currently isn't used.  L<[perl #131193]|https://rt.perl.org/Ticket/Display.html?id=131193>
+
+=item *
+
+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().  L<[perl
+#133913]|https://rt.perl.org/Ticket/Display.html?id=133913>
+
+=item *
+
+Parsing the following constructs within a sub-parse (such as with
+C<"${code here}"> or C<s/.../code here/e>) has changed to match how
+they're parsed normally:
+
+=over
+
+=item *
+
+C<print $fh ...> no longer produces a syntax error.
+
+=item *
+
+Code like C<s/.../ ${time} /e> now properly produces an "Ambiguous use
+of ${time} resolved to $time at ..." warning when warnings are enabled.
+
+=item *
+
+C<@x {"a"}> (with the space) in a sub-parse now properly produces a
+"better written as" warning when warnings are enabled.
+
+=item *
+
+attributes can now be used in a sub-parse.
+
+=back
+
+L<[perl #133850]|https://rt.perl.org/Ticket/Display.html?id=133850>
+
+=item *
+
+Incomplete hex and binary literals like C<0x> and C<0b> are now
+treated as if the C<x> or C<b> is part of the next token.  L<[perl
+#134125]|https://rt.perl.org/Ticket/Display.html?id=134125>
+
+=item *
+
+A spurious C<)> in a subparse, such as in C<s/.../code here/e> or
+C<"...${code here}">, no longer confuses the parser.
+
+Previously a subparse was bracketed with generated C<(> and C<)>
+tokens, so a spurious C<)> would close the construct without doing the
+normal subparse clean up, confusing the parser and possible causing an
+assertion failure.
+
+Such constructs are now surrounded by artificial tokens that can't be
+included in the source.  L<[perl #130585]|https://rt.perl.org/Ticket/Display.html?id=130585>
+
+=item *
+
+Reference assignment of a sub, such as C<\&foo = \&bar;>, silently did
+nothing in the C<main::> package.  L<[perl #134072]|https://rt.perl.org/Ticket/Display.html?id=134072>
+
+=item *
+
+sv_gets() now recovers better if the target SV is modified by a signal
+handler.  L<[perl #134035]|https://rt.perl.org/Ticket/Display.html?id=134035>
+
+=item *
+
+C<readline @foo> now evaluates C<@foo> in scalar context.  Previously
+it would be evalauted in list context, and since readline() pops only
+one argument from the stack, the stack could underflow, or be left
+with unexpected values on the stack.  L<[perl #133989]|https://rt.perl.org/Ticket/Display.html?id=133989>
+
+=back
+
+=head1 Acknowledgements
+
+Perl 5.31.1 represents approximately 4 weeks of development since Perl
+5.31.0 and contains approximately 37,000 lines of changes across 500 files
+from 20 authors.
+
+Excluding auto-generated files, documentation and release tools, there were
+approximately 19,000 lines of changes to 340 .pm, .t, .c and .h files.
+
+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.1:
+
+Alexandr Savca, Andreas König, Chris 'BinGOs' Williams, Dagfinn Ilmari
+Mannsåker, Dominic Hargreaves, Graham Knop, Hugo van der Sanden, James E
+Keenan, Jerome Duval, Karen Etheridge, Karl Williamson, Manuel Mausz,
+Michael Haardt, Nicolas R., Pali, Richard Leach, Sawyer X, Steve Hay, Tony
+Cook, Vickenty Fesunov.
+
+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.
+
+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.
+
+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 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
+sufficient test case.  Your bug report, along with the output of C<perl -V>,
+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.
+
+=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:
+
+    perlthanks
+
+This will send an email to the Perl 5 Porters list with your show of thanks.
+
+=head1 SEE ALSO
+
+The F<Changes> file for an explanation of how to view exhaustive details on
+what changed.
+
+The F<INSTALL> file for how to build Perl.
+
+The F<README> file for general stuff.
+
+The F<Artistic> and F<Copying> files for copyright information.
+
+=cut
index e274f62..2fa34c7 100644 (file)
 
 =head1 NAME
 
-perldelta - what is new for perl v5.31.1
+[ 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
 
 =head1 DESCRIPTION
 
-This document describes differences between the 5.31.0 release and the 5.31.1
+This document describes differences between the 5.31.1 release and the 5.31.2
 release.
 
-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.
+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 Incompatible Changes
+=head1 Notice
 
-=head2 Use of L<C<vec>|perlfunc/vec EXPR,OFFSET,BITS> on strings with code points above 0xFF is forbidden
+XXX Any important notices here
 
-Such strings are represented internally in UTF-8, and C<vec> is a
-bit-oriented operation that will likely give unexpected results on those
-strings.  This was deprecated in perl 5.28.0.
+=head1 Core Enhancements
 
-=head2 Use of code points over 0xFF in string bitwise operators
+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.
 
-Some uses of these were already illegal after a previous deprecation
-cycle.  The remaining uses are now prohibited, having been deprecated in perl
-5.28.0.  See L<perldeprecation>.
+[ List each enhancement as a =head2 entry ]
 
-=head2 C<Sys::Hostname::hostname()> does not accept arguments
+=head1 Security
 
-This usage was deprecated in perl 5.28.0 and is now fatal.
+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.
 
-=head1 Modules and Pragmata
+[ List each security issue as a =head2 entry ]
 
-=head2 Updated Modules and Pragmata
+=head1 Incompatible Changes
 
-=over 4
+XXX For a release on a stable branch, this section aspires to be:
 
-=item *
+    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.
 
-L<Class::Struct> has been upgraded from version 0.65 to 0.66.
+[ List each incompatible change as a =head2 entry ]
 
-=item *
+=head1 Deprecations
 
-L<Compress::Raw::Bzip2> has been upgraded from version 2.084 to 2.086.
+XXX Any deprecated features, syntax, modules etc. should be listed here.
 
-=item *
+=head2 Module removals
 
-L<Compress::Raw::Zlib> has been upgraded from version 2.084 to 2.086.
+XXX Remove this section if not applicable.
 
-=item *
+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.
 
-L<CPAN> has been upgraded from version 2.22 to 2.27.
+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.
 
-=item *
+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.
 
-L<DB_File> has been upgraded from version 1.843 to 1.852.
+=over
 
-=item *
+=item XXX
 
-L<Devel::PPPort> has been upgraded from version 3.52 to 3.53.
+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.
 
-=item *
+=back
 
-L<ExtUtils::CBuilder> has been upgraded from version 0.280231 to 0.280232.
+[ List each other deprecation as a =head2 entry ]
 
-=item *
+=head1 Performance Enhancements
 
-L<ExtUtils::MakeMaker> has been upgraded from version 7.34 to 7.36.
+XXX Changes which enhance performance without changing behaviour go here.
+There may well be none in a stable release.
 
-=item *
+[ List each enhancement as an =item entry ]
 
-L<I18N::LangTags> has been upgraded from version 0.43 to 0.44.
+=over 4
 
 =item *
 
-L<IO> has been upgraded from version 1.40 to 1.41.
+XXX
 
-The supplied I<TO> is now always honoured on calls to the send()
-method.  L<[perl #133936]|https://rt.perl.org/Ticket/Display.html?id=133936>
+=back
 
-=item *
+=head1 Modules and Pragmata
 
-L<IO::Compress> has been upgraded from version 2.084 to 2.086.
+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.
 
-=item *
+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.)
 
-L<Module::CoreList> has been upgraded from version 5.20190524 to 5.20190620.
+[ Within each section, list entries as an =item entry ]
 
-=item *
+=head2 New Modules and Pragmata
 
-L<overload> has been upgraded from version 1.30 to 1.31.
+=over 4
 
 =item *
 
-L<Pod::Simple> has been upgraded from version 3.36 to 3.38.
+XXX Remove this section if not applicable.
 
-=item *
+=back
 
-L<podlators> has been upgraded from version 4.11 to 4.12.
+=head2 Updated Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<POSIX> has been upgraded from version 1.88 to 1.89.
+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<SelfLoader> has been upgraded from version 1.25 to 1.26.
+=back
+
+=head2 Removed Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<Storable> has been upgraded from version 3.15 to 3.16.
+XXX
 
-Regular expressions objects weren't properly counted for object id
-purposes on retrieve.  This would corrupt the resulting structure, or
-cause a runtime error in some cases.  L<[perl #134179]|https://rt.perl.org/Ticket/Display.html?id=134179>
+=back
 
-=item *
+=head1 Documentation
 
-L<Sys::Hostname> has been upgraded from version 1.22 to 1.23.
+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>.
 
-=item *
+=head2 New Documentation
 
-L<Test::Simple> has been upgraded from version 1.302162 to 1.302164.
+XXX Changes which create B<new> files in F<pod/> go here.
 
-=item *
+=head3 L<XXX>
 
-L<Tie::File> has been upgraded from version 1.02 to 1.03.
+XXX Description of the purpose of the new file here
 
-=item *
+=head2 Changes to Existing Documentation
 
-L<Tie::Hash::NamedCapture> has been upgraded from version 0.10 to 0.11.
+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>.
 
-=item *
+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.
 
-L<Time::HiRes> has been upgraded from version 1.9760 to 1.9761.
+Additionally, the following selected changes have been made:
 
-=item *
+=head3 L<XXX>
 
-L<Unicode::Normalize> has been upgraded from version 1.26 to 1.27.
+=over 4
 
 =item *
 
-L<Unicode::UCD> has been upgraded from version 0.72 to 0.73.
+XXX Description of the change here
 
-=item *
+=back
 
-L<warnings> has been upgraded from version 1.44 to 1.45.
+=head1 Diagnostics
 
-=item *
+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>.
 
-L<XS::APItest> has been upgraded from version 1.00 to 1.01.
+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.
 
-=back
+=head2 New Diagnostics
 
-=head2 Removed Modules and Pragmata
+XXX Newly added diagnostic messages go under here, separated into New Errors
+and New Warnings
+
+=head3 New Errors
 
 =over 4
 
 =item *
 
-Pod::Parser has been removed from the core distribution.
-It still is available for download from CPAN.  This resolves L<[perl
-#119439]|https://rt.perl.org/Ticket/Display.html?id=119439>.
+XXX L<message|perldiag/"message">
 
 =back
 
-=head1 Documentation
+=head3 New Warnings
 
-=head2 Changes to Existing Documentation
+=over 4
 
-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>.
+=item *
 
-Additionally, the following selected changes have been made:
+XXX L<message|perldiag/"message">
 
-=head3 L<perlguts>
+=back
+
+=head2 Changes to Existing Diagnostics
+
+XXX Changes (i.e. rewording) of diagnostic messages go here
 
 =over 4
 
 =item *
 
-Documentation about embed.fnc flags has been removed. F<embed.fnc> now has
-sufficient comments within it.  Anyone changing that file will see those
-comments first, so entries here are now redundant.
+XXX Describe change here
 
 =back
 
-=head3 L<perlpod>
+=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 *
 
-Advice has been added regarding the usage of C<< ZE<lt>E<gt> >>.
+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 *
 
-F<autodoc.pl>
-
-This tool that regenerates L<perlintern> and L<perlapi> has been overhauled
-significantly, restoring consistency in flags used in F<embed.fnc> and
-L<Devel::PPPort> and allowing removal of many redundant C<=for apidoc>
-entries in code.
+XXX
 
 =back
 
-=head1 Platform Support
+=head1 Testing
 
-=head2 Discontinued Platforms
+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.
 
-=over 4
+XXX If there were no significant test changes, say this:
 
-=item Windows CE
+Tests were added and changed to reflect the other additions and changes
+in this release.
 
-Support for building perl on Windows CE has now been removed.
+XXX If instead there were significant changes, say this:
 
-=back
+Tests were added and changed to reflect the other additions and
+changes in this release.  Furthermore, these significant changes were
+made:
 
-=head1 Internal Changes
+[ List each test improvement as an =item entry ]
 
 =over 4
 
 =item *
 
-L<eval_pv()|perlapi/eval_pv> no longer stringifies the exception when
-C<croak_on_error> is true.  L<[perl #134175]|https://rt.perl.org/Ticket/Display.html?id=134175>
+XXX
 
 =back
 
-=head1 Selected Bug Fixes
+=head1 Platform Support
 
-=over 4
+XXX Any changes to platform support should be listed in the sections below.
 
-=item *
+[ Within the sections, list each platform as an =item entry with specific
+changes as paragraphs below it. ]
 
-Setting C<$)> now properly sets supplementary group ids if you have
-the necessary privileges.  L<[perl #134169]|https://rt.perl.org/Ticket/Display.html?id=134169>
+=head2 New Platforms
 
-=item *
+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.
 
-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.  L<[perl #122112]|https://rt.perl.org/Ticket/Display.html?id=122112>
+=over 4
 
-=item *
+=item XXX-some-platform
 
-C<< sprintf("%.*a", -10000, $x) >> would cause a buffer overflow due
-to mishandling of the negative precision value.  L<[perl #134008]|https://rt.perl.org/Ticket/Display.html?id=134008>
+XXX
 
-=item *
+=back
 
-scalar() on a reference could cause an erroneous assertion failure
-during compilation.  L<[perl #134045]|https://rt.perl.org/Ticket/Display.html?id=134045>
+=head2 Discontinued Platforms
 
-=item *
+XXX List any platforms that this version of perl no longer compiles on.
 
-C<%{^CAPTURE_ALL}> is now an alias to C<%-> as documented, rather than
-incorrectly an alias for C<%+>.  L<[perl #131867]|https://rt.perl.org/Ticket/Display.html?id=131867>
+=over 4
 
-=item *
+=item XXX-some-platform
 
-C<%{^CAPTURE}> didn't work if C<@{^CAPTURE}> was mentioned first.
-Similarly for C<%{^CAPTURE_ALL}> and C<@{^CAPTURE_ALL}>, though
-C<@{^CAPTURE_ALL}> currently isn't used.  L<[perl #131193]|https://rt.perl.org/Ticket/Display.html?id=131193>
+XXX
 
-=item *
+=back
 
-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().  L<[perl
-#133913]|https://rt.perl.org/Ticket/Display.html?id=133913>
+=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.
 
-Parsing the following constructs within a sub-parse (such as with
-C<"${code here}"> or C<s/.../code here/e>) has changed to match how
-they're parsed normally:
+=over 4
 
-=over
+=item XXX-some-platform
 
-=item *
+XXX
 
-C<print $fh ...> no longer produces a syntax error.
+=back
 
-=item *
+=head1 Internal Changes
 
-Code like C<s/.../ ${time} /e> now properly produces an "Ambiguous use
-of ${time} resolved to $time at ..." warning when warnings are enabled.
+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.
 
-=item *
+[ List each change as an =item entry ]
 
-C<@x {"a"}> (with the space) in a sub-parse now properly produces a
-"better written as" warning when warnings are enabled.
+=over 4
 
 =item *
 
-attributes can now be used in a sub-parse.
+XXX
 
 =back
 
-L<[perl #133850]|https://rt.perl.org/Ticket/Display.html?id=133850>
+=head1 Selected Bug Fixes
 
-=item *
+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>.
 
-Incomplete hex and binary literals like C<0x> and C<0b> are now
-treated as if the C<x> or C<b> is part of the next token.  L<[perl
-#134125]|https://rt.perl.org/Ticket/Display.html?id=134125>
+[ List each fix as an =item entry ]
+
+=over 4
 
 =item *
 
-A spurious C<)> in a subparse, such as in C<s/.../code here/e> or
-C<"...${code here}">, no longer confuses the parser.
+XXX
 
-Previously a subparse was bracketed with generated C<(> and C<)>
-tokens, so a spurious C<)> would close the construct without doing the
-normal subparse clean up, confusing the parser and possible causing an
-assertion failure.
+=back
 
-Such constructs are now surrounded by artificial tokens that can't be
-included in the source.  L<[perl #130585]|https://rt.perl.org/Ticket/Display.html?id=130585>
+=head1 Known Problems
 
-=item *
+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.
 
-Reference assignment of a sub, such as C<\&foo = \&bar;>, silently did
-nothing in the C<main::> package.  L<[perl #134072]|https://rt.perl.org/Ticket/Display.html?id=134072>
+[ List each fix as an =item entry ]
 
-=item *
-
-sv_gets() now recovers better if the target SV is modified by a signal
-handler.  L<[perl #134035]|https://rt.perl.org/Ticket/Display.html?id=134035>
+=over 4
 
 =item *
 
-C<readline @foo> now evaluates C<@foo> in scalar context.  Previously
-it would be evalauted in list context, and since readline() pops only
-one argument from the stack, the stack could underflow, or be left
-with unexpected values on the stack.  L<[perl #133989]|https://rt.perl.org/Ticket/Display.html?id=133989>
+XXX
 
 =back
 
-=head1 Acknowledgements
+=head1 Errata From Previous Releases
 
-Perl 5.31.1 represents approximately 4 weeks of development since Perl
-5.31.0 and contains approximately 37,000 lines of changes across 500 files
-from 20 authors.
+=over 4
 
-Excluding auto-generated files, documentation and release tools, there were
-approximately 19,000 lines of changes to 340 .pm, .t, .c and .h files.
+=item *
 
-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.1:
+XXX Add anything here that we forgot to add, or were mistaken about, in
+the perldelta of a previous release.
 
-Alexandr Savca, Andreas König, Chris 'BinGOs' Williams, Dagfinn Ilmari
-Mannsåker, Dominic Hargreaves, Graham Knop, Hugo van der Sanden, James E
-Keenan, Jerome Duval, Karen Etheridge, Karl Williamson, Manuel Mausz,
-Michael Haardt, Nicolas R., Pali, Richard Leach, Sawyer X, Steve Hay, Tony
-Cook, Vickenty Fesunov.
+=back
 
-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.
+=head1 Obituary
+
+XXX If any significant core contributor or member of the CPAN community has
+died, add a short obituary here.
+
+=head1 Acknowledgements
 
-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.
+XXX Generate this with:
 
-For a more complete list of all of Perl's historical contributors, please
-see the F<AUTHORS> file in the Perl source distribution.
+  perl Porting/acknowledgements.pl v5.31.1..HEAD
 
 =head1 Reporting Bugs
 
index 5d334ef..b41fd19 100644 (file)
@@ -313,7 +313,7 @@ utils : $(utils1) $(utils2) $(utils3) $(utils4) $(utils5)
 extra.pods : miniperl
        @ @extra_pods.com
 
-PERLDELTA_CURRENT = [.pod]perl5311delta.pod
+PERLDELTA_CURRENT = [.pod]perl5312delta.pod
 
 $(PERLDELTA_CURRENT) : [.pod]perldelta.pod
        Copy/NoConfirm/Log $(MMS$SOURCE) $(PERLDELTA_CURRENT)
index a350fa1..f3ec07a 100644 (file)
@@ -1761,7 +1761,7 @@ utils: $(HAVEMINIPERL) ..\utils\Makefile
        copy ..\README.tw       ..\pod\perltw.pod
        copy ..\README.vos      ..\pod\perlvos.pod
        copy ..\README.win32    ..\pod\perlwin32.pod
-       copy ..\pod\perldelta.pod ..\pod\perl5311delta.pod
+       copy ..\pod\perldelta.pod ..\pod\perl5312delta.pod
        $(MINIPERL) -I..\lib $(PL2BAT) $(UTILS)
        $(MINIPERL) -I..\lib ..\autodoc.pl ..
        $(MINIPERL) -I..\lib ..\pod\perlmodlib.PL -q ..
@@ -1859,7 +1859,7 @@ distclean: realclean
        -if exist $(LIBDIR)\Win32API rmdir /s /q $(LIBDIR)\Win32API
        -if exist $(LIBDIR)\XS rmdir /s /q $(LIBDIR)\XS
        -cd $(PODDIR) && del /f *.html *.bat roffitall \
-           perl5311delta.pod perlaix.pod perlamiga.pod perlandroid.pod \
+           perl5312delta.pod perlaix.pod perlamiga.pod perlandroid.pod \
            perlapi.pod perlbs2000.pod perlcn.pod perlcygwin.pod \
            perldos.pod perlfreebsd.pod perlhaiku.pod perlhpux.pod \
            perlhurd.pod perlintern.pod perlirix.pod perljp.pod perlko.pod \
index 3dea8c5..96d638f 100644 (file)
@@ -1282,7 +1282,7 @@ utils: $(PERLEXE) ..\utils\Makefile
        copy ..\README.tw       ..\pod\perltw.pod
        copy ..\README.vos      ..\pod\perlvos.pod
        copy ..\README.win32    ..\pod\perlwin32.pod
-       copy ..\pod\perldelta.pod ..\pod\perl5311delta.pod
+       copy ..\pod\perldelta.pod ..\pod\perl5312delta.pod
        cd ..\win32
        $(PERLEXE) $(PL2BAT) $(UTILS)
        $(MINIPERL) -I..\lib ..\autodoc.pl ..
@@ -1381,7 +1381,7 @@ distclean: realclean
        -if exist $(LIBDIR)\Win32API rmdir /s /q $(LIBDIR)\Win32API
        -if exist $(LIBDIR)\XS rmdir /s /q $(LIBDIR)\XS
        -cd $(PODDIR) && del /f *.html *.bat roffitall \
-           perl5311delta.pod perlaix.pod perlamiga.pod perlandroid.pod \
+           perl5312delta.pod perlaix.pod perlamiga.pod perlandroid.pod \
            perlapi.pod perlbs2000.pod perlcn.pod perlcygwin.pod \
            perldos.pod perlfreebsd.pod perlhaiku.pod perlhpux.pod \
            perlhurd.pod perlintern.pod perlirix.pod perljp.pod perlko.pod \
index e3f2d4b..0e1ff43 100644 (file)
@@ -1678,7 +1678,7 @@ utils: $(HAVEMINIPERL) ..\utils\Makefile
        copy ..\README.tw       ..\pod\perltw.pod
        copy ..\README.vos      ..\pod\perlvos.pod
        copy ..\README.win32    ..\pod\perlwin32.pod
-       copy ..\pod\perldelta.pod ..\pod\perl5311delta.pod
+       copy ..\pod\perldelta.pod ..\pod\perl5312delta.pod
        $(MINIPERL) -I..\lib $(PL2BAT) $(UTILS)
        $(MINIPERL) -I..\lib ..\autodoc.pl ..
        $(MINIPERL) -I..\lib ..\pod\perlmodlib.PL -q ..
@@ -1776,7 +1776,7 @@ distclean: realclean
        -if exist $(LIBDIR)\Win32API rmdir /s /q $(LIBDIR)\Win32API
        -if exist $(LIBDIR)\XS rmdir /s /q $(LIBDIR)\XS
        -cd $(PODDIR) && del /f *.html *.bat roffitall \
-           perl5311delta.pod perlaix.pod perlamiga.pod perlandroid.pod \
+           perl5312delta.pod perlaix.pod perlamiga.pod perlandroid.pod \
            perlapi.pod perlbs2000.pod perlcn.pod perlcygwin.pod \
            perldos.pod perlfreebsd.pod perlhaiku.pod perlhpux.pod \
            perlhurd.pod perlintern.pod perlirix.pod perljp.pod perlko.pod \
index 8fe14ea..7579103 100644 (file)
@@ -60,6 +60,7 @@ POD = perl.pod        \
        perl5300delta.pod       \
        perl5310delta.pod       \
        perl5311delta.pod       \
+       perl5312delta.pod       \
        perl561delta.pod        \
        perl56delta.pod \
        perl581delta.pod        \
@@ -215,6 +216,7 @@ MAN = perl.man      \
        perl5300delta.man       \
        perl5310delta.man       \
        perl5311delta.man       \
+       perl5312delta.man       \
        perl561delta.man        \
        perl56delta.man \
        perl581delta.man        \
@@ -370,6 +372,7 @@ HTML = perl.html    \
        perl5300delta.html      \
        perl5310delta.html      \
        perl5311delta.html      \
+       perl5312delta.html      \
        perl561delta.html       \
        perl56delta.html        \
        perl581delta.html       \
@@ -525,6 +528,7 @@ TEX = perl.tex      \
        perl5300delta.tex       \
        perl5310delta.tex       \
        perl5311delta.tex       \
+       perl5312delta.tex       \
        perl561delta.tex        \
        perl56delta.tex \
        perl581delta.tex        \