This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Supply missing right brace in regex example
[perl5.git] / pod / perldelta.pod
index f112a53..6dfb854 100644 (file)
 
 =head1 NAME
 
-perldelta - what is new for perl v5.31.2
+[ 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.1 release and the 5.31.2
+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.31.0, first read
-L<perl5311delta>, which describes differences between 5.31.0 and 5.31.1.
+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 Modules and Pragmata
+=head1 Notice
 
-=head2 Updated Modules and Pragmata
+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 Now can dump compiled patterns before optimization
+
+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 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 not applicable.
+
+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
+
+[ List each other deprecation as a =head2 entry ]
+
+=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<Devel::PPPort> has been upgraded from version 3.53 to 3.54.
+XXX
 
-=item *
+=back
 
-L<Exporter> has been upgraded from version 5.73 to 5.74.
+=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<IPC::Cmd> has been upgraded from version 1.02 to 1.04.
+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<JSON::PP> has been upgraded from version 4.02 to 4.04.
+=head2 New Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<Module::CoreList> has been upgraded from version 5.20190620 to 5.20190720.
+XXX Remove this section if not applicable.
 
-=item *
+=back
+
+=head2 Updated Modules and Pragmata
 
-L<Opcode> has been upgraded from version 1.43 to 1.44.
+=over 4
 
 =item *
 
-L<PerlIO::encoding> has been upgraded from version 0.27 to 0.28.
+L<XXX> has been upgraded from version A.xx to B.yy.
+
+If there was something important to note about this change, include that here.
+
+=back
+
+=head2 Removed Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<Pod::Simple> has been upgraded from version 3.38 to 3.39.
+XXX
+
+=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<XXX>
+
+=over 4
 
 =item *
 
-L<threads::shared> has been upgraded from version 1.60 to 1.61.
+XXX Description of the change 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
+
 =head3 New Errors
 
 =over 4
 
 =item *
 
-C<L<No digits found for %s literal|perldiag/"No digits found for %s literal">>
+XXX L<message|perldiag/"message">
 
-(F) No hexadecimal digits were found following C<0x> or no binary digits were
-found following C<0b>.
+=back
+
+=head3 New Warnings
+
+=over 4
+
+=item *
+
+XXX L<message|perldiag/"message">
 
 =back
 
 =head2 Changes to Existing Diagnostics
 
+XXX Changes (i.e. rewording) of diagnostic messages go here
+
 =over 4
 
 =item *
 
-C<\N{} here is restricted to one character> is now emitted in the same
-circumstances where previously C<\N{} in inverted character class or as a range
-end-point is restricted to one character> was.
+XXX Describe change here
 
-This is due to new circumstances having been added in Perl 5.30 that weren't
-covered by the earlier wording.
+=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>.
+
+[ 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 *
+
+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 *
 
-The C<ECHO> macro is now defined.  This is used in a C<dtrace> rule that was
-originally changed for FreeBSD, and the FreeBSD make apparently predefines it.
-The Solaris make does not predefine C<ECHO> which broke this rule on Solaris.
-L<[perl #134218]|https://rt.perl.org/Ticket/Display.html?id=134218>
+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:
+
+Tests were added and changed to reflect the other additions and changes
+in this release.
+
+XXX If instead there were significant changes, say this:
+
+Tests were added and changed to reflect the other additions and
+changes in this release.  Furthermore, these significant changes were
+made:
+
+[ List each test improvement as an =item entry ]
+
+=over 4
 
 =item *
 
-Bison versions 3.1 through 3.4 are now supported.
+XXX
 
 =back
 
 =head1 Platform Support
 
-=head2 Platform-Specific Notes
+XXX Any changes to platform support should be listed in the sections below.
 
-=over 4
+[ Within the sections, list each platform as an =item entry with specific
+changes as paragraphs below it. ]
 
-=item Linux
+=head2 New Platforms
 
-C<cc> will be used to populate C<plibpth> if C<cc> is C<clang>.
-L<[perl #134189]|https://rt.perl.org/Ticket/Display.html?id=134189>
+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 VMS
+=over 4
+
+=item XXX-some-platform
 
-C<-Duse64bitint> is now the default on VMS.
+XXX
 
 =back
 
-=head1 Internal Changes
+=head2 Discontinued Platforms
 
-=over 4
+XXX List any platforms that this version of perl no longer compiles on.
 
-=item *
+=over 4
 
-The PERL_DESTRUCT_LEVEL environment variable was formerly only honoured on perl
-binaries built with DEBUGGING support.  It is now checked on all perl builds.
-Its normal use is to force perl to individually free every block of memory
-which it has allocated before exiting, which is useful when using automated
-leak detection tools such as valgrind.
+=item XXX-some-platform
 
-=item *
+XXX
 
-The API eval_sv() now accepts a C<G_RETHROW> flag.  If this flag is set and an
-exception is thrown while compiling or executing the supplied code, it will be
-rethrown, and eval_sv() will not return.
-L<[perl #134177]|https://rt.perl.org/Ticket/Display.html?id=134177>
+=back
 
-=item *
+=head2 Platform-Specific Notes
 
-As part of the fix for
-L<[perl #2754]|https://rt.perl.org/Ticket/Display.html?id=2754> perl_parse()
-now returns non-zero if exit(0) is called in a C<BEGIN>, C<UNITCHECK> or
-C<CHECK> block.
+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.
 
-=item *
+=over 4
 
-Most functions which recursively walked an op tree during compilation have been
-made non-recursive.  This avoids SEGVs from stack overflow when the op tree is
-deeply nested, such as C<$n == 1 ? "one" : $n == 2 ? "two" : ....> (especially
-in code which is auto-generated).
+=item XXX-some-platform
 
-This is particularly noticeable where the code is compiled within a separate
-thread, as threads tend to have small stacks by default.
+XXX
 
 =back
 
-=head1 Selected Bug Fixes
+=head1 Internal Changes
 
-=over 4
+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 ]
 
-Parsing incomplete hex or binary literals was changed in 5.31.1 to treat such a
-literal as just the 0, leaving the following C<x> or C<b> to be parsed as part
-of the next token.  This could lead to some silent changes in behaviour, so now
-incomplete hex or binary literals produce a fatal error.
-L<[perl #134125]|https://rt.perl.org/Ticket/Display.html?id=134125>
+=over 4
 
 =item *
 
-eval_pv()'s I<croak_on_error> flag will now throw even if the exception is a
-false overloaded value.
-L<[perl #134177]|https://rt.perl.org/Ticket/Display.html?id=134177>
+XXX
 
-=item *
+=back
 
-C<INIT> blocks and the program itself are no longer run if exit(0) is called
-within a C<BEGIN>, C<UNITCHECK> or C<CHECK> block.
-L<[perl #2754]|https://rt.perl.org/Ticket/Display.html?id=2754>
+=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>.
 
-C<<< open my $fh, ">>+", undef >>> now opens the temporary file in append mode
-- writes will seek to the end of file before writing.
-L<[perl #134221]|https://rt.perl.org/Ticket/Display.html?id=134221>
+[ List each fix as an =item entry ]
+
+=over 4
 
 =item *
 
-Fixed a SEGV when searching for the source of an uninitialized value warning on
-an op whose subtree includes an OP_MULTIDEREF.
-L<[perl #134275]|https://rt.perl.org/Ticket/Display.html?id=134275>
+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]
 
 =back
 
 =head1 Known Problems
 
-=over 4
+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.
 
-=item *
+[ List each fix as an =item entry ]
 
-The VC++ 6.0 build on Windows is currently broken.  Support for this compiler
-is likely to be removed in the near future.
+=over 4
 
 =item *
 
-Tests 9-11 in F<t/op/blocks.t> currently fail on Windows.
-L<[perl #134295]|https://rt.perl.org/Ticket/Display.html?id=134295>
+XXX
 
 =back
 
-=head1 Acknowledgements
+=head1 Errata From Previous Releases
+
+=over 4
 
-Perl 5.31.2 represents approximately 4 weeks of development since Perl 5.31.1
-and contains approximately 7,600 lines of changes across 190 files from 16
-authors.
+=item *
+
+XXX Add anything here that we forgot to add, or were mistaken about, in
+the perldelta of a previous release.
 
-Excluding auto-generated files, documentation and release tools, there were
-approximately 3,100 lines of changes to 99 .pm, .t, .c and .h files.
+=back
 
-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.2:
+=head1 Obituary
 
-Alexandr Savca, Chris 'BinGOs' Williams, Craig A. Berry, Dagfinn Ilmari
-MannsÃ¥ker, David Mitchell, H.Merijn Brand, James E Keenan, Karen Etheridge,
-Karl Williamson, Nicolas R., Pali, Paul Evans, Richard Leach, Steve Hay,
-Svyatoslav, Tony Cook.
+XXX If any significant core contributor or member of the CPAN community has
+died, add a short obituary here.
 
-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 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
 
-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
+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
@@ -257,13 +431,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