This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Rewrite paragraph on using strict and warnings
[perl5.git] / pod / perldelta.pod
index 63ef848..6dfb854 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.4
 
 =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.3 release and the 5.31.4
 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.2, first read
+L<perl5313delta>, which describes differences between 5.31.2 and 5.31.3.
 
-=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
+=head2 Now can dump compiled patterns before optimization
 
-This usage was deprecated in perl 5.28.0 and is now fatal.
+This is primarily useful for tracking down bugs in the regular
+expression compiler.  This dump happens on C<-DDEBUGGING> perls, if you
+specify C<-Drv> on the command line; or on any perl if the pattern is
+compiled within the scope of S<C<use re qw(Debug DUMP_PRE_OPTIMIZE)>> or
+S<C<use re qw(Debug COMPILE EXTRA)>>.  (All but the 2nd case display
+other information as well.)
 
-=head1 Modules and Pragmata
+=head1 Security
 
-=head2 Updated Modules and Pragmata
+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.
 
-=over 4
+[ List each security issue as a =head2 entry ]
 
-=item *
+=head1 Incompatible Changes
 
-L<Class::Struct> has been upgraded from version 0.65 to 0.66.
+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<Compress::Raw::Bzip2> has been upgraded from version 2.084 to 2.086.
+[ List each incompatible change as a =head2 entry ]
 
-=item *
+=head1 Deprecations
 
-L<Compress::Raw::Zlib> 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<CPAN> has been upgraded from version 2.22 to 2.27.
+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<DB_File> has been upgraded from version 1.843 to 1.852.
+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<Devel::PPPort> has been upgraded from version 3.52 to 3.53.
+=over
 
-=item *
+=item XXX
 
-L<ExtUtils::CBuilder> has been upgraded from version 0.280231 to 0.280232.
+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::MakeMaker> has been upgraded from version 7.34 to 7.36.
+[ List each other deprecation as a =head2 entry ]
 
-=item *
+=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 ]
 
-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
+
+=head2 Updated Modules and Pragmata
 
-L<podlators> has been upgraded from version 4.11 to 4.12.
+=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.
+
+=back
 
-L<SelfLoader> has been upgraded from version 1.25 to 1.26.
+=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">
+
+=back
+
+=head2 Changes to Existing Diagnostics
 
-=head3 L<perlguts>
+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.
+Perl no longer treats strings starting with "0x" or "0b" as hex or
+binary numbers respectively when converting a string to a number.
+This reverts a change in behaviour inadvertently introduced in perl
+5.30.0 intended to improve precision when converting a string to a
+floating point number. [perl #134230]
 
-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.3..HEAD
 
 =head1 Reporting Bugs