This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
New perldelta for 5.29.7
[perl5.git] / pod / perldelta.pod
index f011dbb..65aad26 100644 (file)
 
 =head1 NAME
 
-perldelta - what is new for perl v5.29.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.29.7
 
 =head1 DESCRIPTION
 
-This document describes differences between the 5.29.0 release and the 5.29.1
+This document describes differences between the 5.29.6 release and the 5.29.7
 release.
 
-If you are upgrading from an earlier release such as 5.28.0, first read
-L<perl5290delta>, which describes differences between 5.28.0 and 5.29.0.
+If you are upgrading from an earlier release such as 5.29.5, first read
+L<perl5296delta>, which describes differences between 5.29.5 and 5.29.6.
+
+=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 ]
 
 =head1 Incompatible Changes
 
-=head2 Delimiters must now be graphemes
+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.
 
-See L<perldeprecation/Use of unassigned code point or non-standalone grapheme
-for a delimiter.>
+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.
 
-=head2 Some formerly deprecated uses of an unescaped left brace C<"{"> in
-regular expression patterns are now illegal
+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.
 
-But to avoid breaking code unnecessarily, most instances that issued a
-deprecation warning, remain legal and now have a non-deprecation warning
-raised.  See L<perldeprecation/Unescaped left braces in regular expressions>.
+=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 *
 
-Translating from UTF-8 into the code point it represents now is done via a
-deterministic finite automaton, speeding it up.  As a typical example,
-C<ord("\x7fff")> now requires 12% fewer instructions than before.  The
-performance of checking that a sequence of bytes is valid UTF-8 is similarly
-improved, again by using a dfa.
+XXX
 
 =back
 
 =head1 Modules and Pragmata
 
-=head2 Updated Modules and Pragmata
-
-=over 4
+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<bignum> has been upgraded from version 0.49 to 0.50.
+[ Within each section, list entries as an =item entry ]
 
-=item *
+=head2 New Modules and Pragmata
 
-L<Compress::Raw::Bzip2> has been upgraded from version 2.074 to 2.081.
+=over 4
 
 =item *
 
-L<Compress::Raw::Zlib> has been upgraded from version 2.076 to 2.081.
+XXX Remove this section if not applicable.
 
-=item *
+=back
 
-L<Config::Perl::V> has been upgraded from version 0.29 to 0.30.
+=head2 Updated Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<DB_File> has been upgraded from version 1.840 to 1.842.
+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<Devel::PPPort> has been upgraded from version 3.40 to 3.42.
+=back
 
-=item *
+=head2 Removed Modules and Pragmata
 
-L<Digest::SHA> has been upgraded from version 6.01 to 6.02.
+=over 4
 
 =item *
 
-L<experimental> has been upgraded from version 0.019 to 0.020.
+XXX
 
-=item *
+=back
 
-L<ExtUtils::Manifest> has been upgraded from version 1.70 to 1.71.
+=head1 Documentation
 
-=item *
+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>.
 
-L<File::Temp> has been upgraded from version 0.2304 to 0.2308.
+=head2 New Documentation
 
-=item *
+XXX Changes which create B<new> files in F<pod/> go here.
 
-IO-Compress has been upgraded from version 2.074 to 2.081.
+=head3 L<XXX>
 
-=item *
+XXX Description of the purpose of the new file here
 
-L<IPC::Cmd> has been upgraded from version 1.00 to 1.02.
+=head2 Changes to Existing Documentation
 
-=item *
+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>.
 
-L<Locale::Codes> has been upgraded from version 3.56 to 3.57.
+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.
 
-=item *
+Additionally, the following selected changes have been made:
 
-L<Math::BigInt> has been upgraded from version 1.999811 to 1.999813.
+=head3 L<XXX>
+
+=over 4
 
 =item *
 
-L<Math::BigInt::FastCalc> has been upgraded from version 0.5006 to 0.5007.
+XXX Description of the change here
 
-=item *
+=back
 
-L<Math::BigRat> has been upgraded from version 0.2613 to 0.2614.
+=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<Module::CoreList> has been upgraded from version 5.20180626 to 5.20180720.
+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.
 
-=item *
+=head2 New Diagnostics
 
-L<parent> has been upgraded from version 0.236 to 0.237.
+XXX Newly added diagnostic messages go under here, separated into New Errors
+and New Warnings
 
-=item *
+=head3 New Errors
 
-L<perlfaq> has been upgraded from version 5.021011 to 5.20180605.
+=over 4
 
 =item *
 
-podlators has been upgraded from version 4.10 to 4.11.
+XXX L<message|perldiag/"message">
 
-=item *
+=back
+
+=head3 New Warnings
 
-L<Storable> has been upgraded from version 3.08 to 3.11.
+=over 4
 
 =item *
 
-L<Test::Simple> has been upgraded from version 1.302133 to 1.302138.
+XXX L<message|perldiag/"message">
 
-=item *
+=back
 
-L<Thread::Queue> has been upgraded from version 3.12 to 3.13.
+=head2 Changes to Existing Diagnostics
 
-=item *
+XXX Changes (i.e. rewording) of diagnostic messages go here
 
-L<Time::Local> has been upgraded from version 1.25 to 1.28.
+=over 4
 
 =item *
 
-L<version> has been upgraded from version 0.9923 to 0.9924.
+XXX Describe change here
 
 =back
 
-=head1 Documentation
-
-=head2 Changes to Existing Documentation
+=head1 Utility Changes
 
-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 to installed programs such as F<perlbug> and F<xsubpp> go here.
+Most of these are built within the directory F<utils>.
 
-Additionally, the following selected changes have been made:
+[ 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. ]
 
-=head3 L<perlapi>
+=head2 L<XXX>
 
 =over 4
 
 =item *
 
-C<AvFILL()> was wrongly listed as deprecated.  This has been corrected.
-L<[perl #133278]|https://rt.perl.org/Ticket/Display.html?id=133278>
+XXX
 
 =back
 
-=head3 L<perlop>
+=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 behaviour of C<tr> when the delimiter is an apostrophe has been clarified.
-In particular, hyphens aren't special, and C<\x{}> isn't interpolated.
-L<[perl #130679]|https://rt.perl.org/Ticket/Display.html?id=130679>
+XXX
 
 =back
 
-=head1 Diagnostics
+=head1 Testing
 
-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 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.
 
-=head2 Changes to Existing Diagnostics
+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 *
 
-As noted under L<Incompatible Changes> above, the deprecation warning
-"Unescaped left brace in regex is deprecated here (and will be fatal in Perl
-5.30), passed through in regex; marked by S<<-- HERE> in m/%s/" has been
-changed to the non-deprecation warning "Unescaped left brace in regex is passed
-through in regex; marked by S<<-- HERE> in m/%s/".
+XXX
 
 =back
 
-=head1 Testing
+=head1 Platform Support
 
-Tests were added and changed to reflect the other additions and changes in this
-release.
+XXX Any changes to platform support should be listed in the sections below.
 
-=head1 Platform Support
+[ Within the sections, list each platform as an =item entry with specific
+changes as paragraphs below it. ]
 
-=head2 Platform-Specific Notes
+=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.
 
 =over 4
 
-=item HP-UX 11.11
+=item XXX-some-platform
 
-An obscure problem in C<pack()> when compiling with HP C-ANSI-C has been fixed
-by disabling optimizations in F<pp_pack.c>.
+XXX
 
-=item Windows
+=back
+
+=head2 Discontinued Platforms
+
+XXX List any platforms that this version of perl no longer compiles on.
 
 =over 4
 
-=item *
+=item XXX-some-platform
 
-The C<USE_CPLUSPLUS> build option which has long been available in
-F<win32/Makefile> (for B<nmake>) and F<win32/makefile.mk> (for B<dmake>) is now
-also available in F<win32/GNUmakefile> (for B<gmake>).
+XXX
 
-=item *
+=back
+
+=head2 Platform-Specific Notes
 
-The B<nmake> makefile no longer defaults to Visual C++ 6.0 (a very old version
-which is unlikely to be widely used today).  As a result, it is now a
-requirement to specify the C<CCTYPE> since there is no obvious choice of which
-modern version to default to instead.  Failure to specify C<CCTYPE> will result
-in an error being output and the build will stop.
+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.
 
-(The B<dmake> and B<gmake> makefiles will automatically detect which compiler
-is being used, so do not require C<CCTYPE> to be set.  This feature has not yet
-been added to the B<nmake> makefile.)
+=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 ]
+
+=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
 
 =item *
 
-Compilation under C<-DPERL_MEM_LOG> and C<-DNO_LOCALE> have been fixed.
+XXX
+
+=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 *
 
-Perl 5.28 introduced an C<index()> optimization when comparing to -1 (or
-indirectly, e.g. >= 0).  When this optimization was triggered inside a C<when>
-clause it caused a warning ("Argument %s isn't numeric in smart match").  This
-has now been fixed.
-L<[perl #133368]|https://rt.perl.org/Ticket/Display.html?id=133368>
+XXX
 
 =back
 
-=head1 Acknowledgements
+=head1 Errata From Previous Releases
 
-Perl 5.29.1 represents approximately 3 weeks of development since Perl 5.29.0
-and contains approximately 68,000 lines of changes across 510 files from 18
-authors.
+=over 4
 
-Excluding auto-generated files, documentation and release tools, there were
-approximately 62,000 lines of changes to 320 .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.29.1:
+XXX Add anything here that we forgot to add, or were mistaken about, in
+the perldelta of a previous release.
 
-Chris 'BinGOs' Williams, Craig A. Berry, Dagfinn Ilmari Mannsåker, Daniel
-Dragan, David Mitchell, François Perrad, H.Merijn Brand, Hugo van der Sanden,
-James E Keenan, Jerry D. Hedden, Jim Cromie, Karen Etheridge, Karl Williamson,
-Nicholas Clark, Sawyer X, Steve Hay, Tina Müller, Yves Orton.
+=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.29.6..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
-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<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
@@ -304,13 +418,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