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 d822eed..65aad26 100644 (file)
 
 =head1 NAME
 
-perldelta - what is new for perl v5.29.5
+[ 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.4 release and the 5.29.5
+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.29.3, first read
-L<perl5294delta>, which describes differences between 5.29.3 and 5.29.4.
+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
 
-=head2 C<-Drv> now means something on C<-DDEBUGGING> builds
+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.
 
-Now, adding the verbose flag (C<-Dv>) to the C<-Dr> flag turns on all
-possible regular expression debugging.
+[ List each enhancement as a =head2 entry ]
 
-=head1 Performance Enhancements
+=head1 Security
 
-=over 4
+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.
 
-=item *
+[ 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
 
-Regular expression pattern matching of things like C<qr/[^I<a>]/> is
-significantly sped up, where I<a> is any ASCII character.  Which classes
-will get this speed up is complicated and depends on the underlying bit
-patterns of those characters, so differs between ASCII and EBCDIC
-platforms, but all case pairs, like C<qr/[Gg]/> are included, as is
-C<[^01]>.
+=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
 
-=head1 Modules and Pragmata
+[ List each other deprecation as a =head2 entry ]
 
-=head2 Updated Modules and Pragmata
+=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<Data::Dumper> has been upgraded from version 2.172 to 2.173.
+XXX
 
-=item *
+=back
+
+=head1 Modules and Pragmata
 
-L<Errno> has been upgraded from version 1.29 to 1.30.
+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<File::Spec> has been upgraded from version 3.75 to 3.76.
+[ Within each section, list entries as an =item entry ]
 
-=item *
+=head2 New Modules and Pragmata
 
-L<GDBM_File> has been upgraded from version 1.17 to 1.18.
+=over 4
 
 =item *
 
-L<Module::CoreList> has been upgraded from version 5.20181020 to 5.20181120.
+XXX Remove this section if not applicable.
 
-=item *
+=back
+
+=head2 Updated Modules and Pragmata
 
-L<NDBM_File> has been upgraded from version 1.14 to 1.15.
+=over 4
 
 =item *
 
-L<ODBM_File> has been upgraded from version 1.15 to 1.16.
+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<re> has been upgraded from version 0.36 to 0.37.
+=head2 Removed Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<SDBM_File> has been upgraded from version 1.14 to 1.15.
+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<perlfunc>
+=head3 L<XXX>
 
 =over 4
 
 =item *
 
-The entry for L<perlfunc/-X> has been clarified to indicate that symbolic
-links are followed for most tests.
+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 *
+
+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 *
+
+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>.
+
+[ 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 *
 
-Normally the thread-safe functions used only on threaded builds.
-It is now possible to force their use on unthreaded builds on systems
-that have them available, by including the
-C<-Accflags='-DUSE_THREAD_SAFE_LOCALE'> option to F<Configure>.
+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 *
+
+XXX
+
+=back
+
 =head1 Platform Support
 
-=head2 Platform-Specific Notes
+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 Mac OS X
+=item XXX-some-platform
 
-Perl's build and testing process on Mac OS X for C<-Duseshrplib>
-builds is now compatible with Mac OS X System Integrity Protection
-(SIP).
+XXX
 
-SIP prevents binaries in F</bin> (and a few other places) being passed
-the C<DYLD_LIBRARY_PATH> environment variable.  For our purposes this
-prevents C<DYLD_LIBRARY_PATH> from being passed to the shell, which
-prevents that variable being passed to the testing or build process,
-so running C<perl> couldn't find F<libperl.dylib>.
+=back
+
+=head2 Discontinued Platforms
 
-To workaround that, the initial build of the F<perl> executable
-expects to find F<libperl.dylib> in the build directory, and the
-library path is then adjusted during installation to point to the
-installed library.
+XXX List any platforms that this version of perl no longer compiles on.
 
-[perl #126706]
+=over 4
 
-=item Minix3
+=item XXX-some-platform
 
-Some support for Minix3 has been re-added.
+XXX
 
 =back
 
-=head1 Selected Bug Fixes
+=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 *
+=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.
 
-L<SDBM_File> is now more robust with corrupt database files.  The
-improvements do not make SDBM files suitable as an interchange format.
-[perl #132147]
+[ List each change as an =item entry ]
+
+=over 4
 
 =item *
 
-C<binmode($fh);> or C<binmode($fh, ':raw');> now properly removes the
-C<:utf8> flag from the default C<:crlf> I/O layer on Win32.  [perl
-#133604]
+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 *
 
-The experimental reference aliasing feature was misinterpreting array and
-hash slice assignment as being localised, e.g.
+XXX
 
-    \(@a[3,5,7]) = \(....);
+=back
 
-was being interpreted as:
+=head1 Known Problems
 
-    local \(@a[3,5,7]) = \(....);
+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.
 
-[perl #133538]
+[ List each fix as an =item entry ]
+
+=over 4
+
+=item *
+
+XXX
 
 =back
 
-=head1 Acknowledgements
+=head1 Errata From Previous Releases
+
+=over 4
 
-Perl 5.29.5 represents approximately 4 weeks of development since Perl
-5.29.4 and contains approximately 4,000 lines of changes across 110 files
-from 18 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 2,600 lines of changes to 51 .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.29.5:
+=head1 Obituary
 
-Aaron Crane, Chris 'BinGOs' Williams, Dagfinn Ilmari MannsÃ¥ker, Dan
-Dedrick, David Cantrell, David Mitchell, Dominic Hargreaves, H.Merijn Brand,
-James Clarke, James E Keenan, Karen Etheridge, Karl Williamson, Niko Tyni,
-Pali, Phil Pearl (Lobbes), Sawyer X, Tomasz Konojacki, 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.29.6..HEAD
 
 =head1 Reporting Bugs