This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for fd879d933c2a2ee22ac6e2462acc016aa033854d
[perl5.git] / pod / perldelta.pod
index 3887d18..b701598 100644 (file)
 
 =head1 NAME
 
-perldelta - what is new for perl v5.29.7
+[ 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.9
 
 =head1 DESCRIPTION
 
-This document describes differences between the 5.29.6 release and the 5.29.7
+This document describes differences between the 5.29.8 release and the 5.29.9
 release.
 
-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.
+If you are upgrading from an earlier release such as 5.29.7, first read
+L<perl5298delta>, which describes differences between 5.29.7 and 5.29.8.
+
+=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 ]
+
+=head2 Unicode 12.0 is supported
+
+For details, see L<https://www.unicode.org/versions/Unicode12.0.0/>.
+
+Because of a change in Unicode release cycles, Perl jumps from Unicode
+10.0 in Perl 5.28 to Unicode 12.0 in Perl 5.30.
+
+=head2 It is now possible to compile perl to always use thread-safe
+locale operations.
+
+Previously, these calls were only used when the perl was compiled to be
+multi-threaded.  To always enable them, add
+
+ -Accflags='-DUSE_THREAD_SAFE_LOCALE'
+
+to your F<Configure> flags.
+
+
+=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 ]
+
+=head2 C<pack()> no longer can return malformed UTF-8
+
+It croaks if it would otherwise return a UTF-8 string that contains
+malformed UTF-8.  This protects agains potential security threats.  This
+is considered a bug fix as well ([perl #131642]).
 
 =head1 Deprecations
 
-=head2 In XS code, use of various macros dealing with UTF-8.
+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.
 
-This deprecation was scheduled to become fatal in 5.30, but has been
-delayed to 5.32 due to problems that showed up with some CPAN modules.
-For details of what's affected, see L<perldeprecation|
-perldeprecation/In XS code, use of various macros dealing with UTF-8.>.
+=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 *
 
-A handful of small optimizations related to character folding
-and character classes in regular expressions.
+XXX
 
 =back
 
@@ -48,6 +133,15 @@ release manager will have to investigate the situation carefully.)
 
 [ Within each section, list entries as an =item entry ]
 
+=head2 New Modules and Pragmata
+
+=over 4
+
+=item *
+
+XXX Remove this section if not applicable.
+
+=back
 
 =head2 Updated Modules and Pragmata
 
@@ -55,41 +149,70 @@ release manager will have to investigate the situation carefully.)
 
 =item *
 
-L<CPAN> has been upgraded from version 2.21 to 2.22.
+L<perl5db.pl> has been upgraded from version 1.54 to 1.55.
+
+Debugging threaded code no longer deadlocks in C<DB::sub> nor
+C<DB::lsub>.
 
 =item *
 
-L<DB_File> has been upgraded from version 1.842 to 1.843.
+L<PerlIO::encoding> has been upgraded from version 0.26 to 0.27.
+
+Warnings enabled by setting the C<WARN_ON_ERR> flag in
+C<$PerlIO::encoding::fallback> are now only produced if warnings are
+enabled with C<use warnings "utf8";> or setting C<$^W>.
 
 =item *
 
-L<File::Find> has been upgraded from version 1.35 to 1.36.
+L<threads::shared> has been upgraded from version 1.59 to 1.60.
+
+Added support for extra tracing of locking, this requires a
+C<-DDEBUGGING> and extra compilation flags.
+
+=back
 
-Variables C<< $Is_Win32 >> and C<< $Is_VMS >> are being initialized.
+=head2 Removed Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<lib> has been upgraded from version 0.64 to 0.65.
+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<perlvar>
+=head3 L<XXX>
 
 =over 4
 
 =item *
 
-More specific documentation of paragraph mode. L<[perl #133722]|https://rt.perl.org/Ticket/Display.html?id=133722>.
+XXX Description of the change here
 
 =back
 
@@ -99,97 +222,231 @@ 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 *
+
+XXX L<message|perldiag/"message">
+
+=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 *
 
-L<Prototype not terminated|perldiag/"Prototype not terminated">
+XXX Describe change here
+
+=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>.
 
-The file and line number is now reported for this error.
-L<[perl #133524]|https://rt.perl.org/Ticket/Display.html?id=133524>
+[ 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 *
+
+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 *
 
-Fix intermittent tests which failed due to race conditions which
-surface during parallel testing. L<[perl #133740]|https://rt.perl.org/Ticket/Display.html?id=133740>.
+XXX
+
+=back
+
+=head1 Platform Support
+
+XXX Any changes to platform support should be listed in the sections below.
+
+[ Within the sections, list each platform as an =item entry with specific
+changes as paragraphs below it. ]
+
+=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 XXX-some-platform
+
+XXX
+
+=back
+
+=head2 Discontinued Platforms
+
+XXX List any platforms that this version of perl no longer compiles on.
+
+=over 4
+
+=item XXX-some-platform
+
+XXX
+
+=back
+
+=head2 Platform-Specific Notes
+
+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.
+
+=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 *
 
-Thoroughly test paragraph mode, using a new test file,
-F<t/io/paragraph_mode.t>. L<[perl #133722]|https://rt.perl.org/Ticket/Display.html?id=133722>.
+Added C<newSVsv_nomg()> to copy a SV without processing get magic on
+the source.  [perl #132964]
 
 =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 *
 
-Fixed a failure to match properly.
+C<pack()> no longer can return malformed UTF-8.  It croaks if it would
+otherwise return a UTF-8 string that contains malformed UTF-8.  This
+protects agains potential security threats.  [perl #131642]
+
+=back
 
-An EXACTFish regnode has a finite length it can hold for the string
-being matched.  If that length is exceeded, a second node is used for
-the next segment of the string, for as many regnodes as are needed.
-Care has to be taken where to break the string, in order to deal
-multi-character folds in Unicode correctly. If we want to break a
-string at a place which could potentially be in the middle of a
-multi-character fold, we back off one (or more) characters, leaving
-a shorter EXACTFish regnode. This backing off mechanism contained
-an off-by-one error. L<[perl #133756]|https://rt.perl.org/Ticket/Display.html?id=133756>.
+=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.
 
-A bare C<eof> call with no previous file handle now returns true.
-L<[perl #133721]|https://rt.perl.org/Ticket/Display.html?id=133721>
+[ List each fix as an =item entry ]
+
+=over 4
 
 =item *
 
-Failing to compile a format now aborts compilation.  Like other errors
-in sub-parses this could leave the parser in a strange state, possibly
-crashing perl if compilation continued.  L<[perl #132158]|https://rt.perl.org/Ticket/Display.html?id=132158>
+XXX
 
 =back
 
-=head1 Acknowledgements
+=head1 Errata From Previous Releases
 
-Perl 5.29.7 represents approximately 5 weeks of development since Perl
-5.29.6 and contains approximately 97,000 lines of changes across 350 files
-from 8 authors.
+=over 4
 
-Excluding auto-generated files, documentation and release tools, there were
-approximately 27,000 lines of changes to 190 .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.7:
+XXX Add anything here that we forgot to add, or were mistaken about, in
+the perldelta of a previous release.
 
-Abigail, Chris 'BinGOs' Williams, Eugen Konkov, Hauke D, James E Keenan,
-Karl Williamson, Tomasz Konojacki, Tony Cook.
+=back
+
+=head1 Obituary
 
-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.
+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.8..HEAD
 
 =head1 Reporting Bugs