This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
New perldelta
[perl5.git] / pod / perldelta.pod
index 495be84..dfe1fd6 100644 (file)
 
 =head1 NAME
 
-perldelta - what is new for perl v5.25.8
+[ 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.25.9
 
 =head1 DESCRIPTION
 
-This document describes differences between the 5.25.7 release and the 5.25.8
+This document describes differences between the 5.25.8 release and the 5.25.9
 release.
 
-If you are upgrading from an earlier release such as 5.25.6, first read
-L<perl5257delta>, which describes differences between 5.25.6 and 5.25.7.
+If you are upgrading from an earlier release such as 5.25.7, first read
+L<perl5258delta>, which describes differences between 5.25.7 and 5.25.8.
+
+=head1 Notice
+
+XXX Any important notices here
 
 =head1 Core Enhancements
 
-=head2 New Hash Function For 64-bit 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.
+
+[ 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
+
+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 inapplicable.
+
+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.
 
-We have switched to a hybrid hash function to better balance
-performance for short and long keys.
+=over
 
-For short keys, 16 bytes and under, we use an optimised variant of
-One At A Time Hard, and for longer keys we use Siphash 1-3. For very
-long keys this is a big improvement in performance. For shorter keys
-there is a modest improvement.
+=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
 
-=over 4
+XXX Changes which enhance performance without changing behaviour go here.
+There may well be none in a stable release.
 
-=item * New Faster Hash Function on 64 bit builds
+[ List each enhancement as a =item entry ]
 
-We use a different hash function for short and long keys. This should
-improve performance and security, especially for long keys.
+=over 4
 
-=item * readline is faster
+=item *
 
-Reading from a file line-by-line with C<readline()> or C<< E<lt>E<gt> >> should
-now typically be faster due to a better implementation of the code that
-searches for the next newline character.
+XXX
 
 =back
 
 =head1 Modules and Pragmata
 
-=head2 Updated Modules and Pragmata
+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.
+
+[ Within each section, list entries as a =item entry ]
+
+=head2 New Modules and Pragmata
 
 =over 4
 
 =item *
 
-L<Archive::Tar> has been upgraded from version 2.18 to 2.24.
+XXX
 
-=item *
+=back
+
+=head2 Updated Modules and Pragmata
 
-L<B::Debug> has been upgraded from version 1.23 to 1.24.
+=over 4
 
 =item *
 
-L<bignum> has been upgraded from version 0.43_01 to 0.47.
+L<XXX> has been upgraded from version A.xx to B.yy.
 
-=item *
+=back
 
-L<Data::Dumper> has been upgraded from version 2.165 to 2.166.
+=head2 Removed Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<Encode> has been upgraded from version 2.86 to 2.88.
+XXX
 
-=item *
+=back
 
-L<encoding> has been upgraded from version 2.18 to 2.19.
+=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<IO> has been upgraded from version 1.37 to 1.38.
+=head2 New Documentation
 
-=item *
+XXX Changes which create B<new> files in F<pod/> go here.
 
-L<Locale::Codes> has been upgraded from version 3.40 to 3.42.
+=head3 L<XXX>
 
-=item *
+XXX Description of the purpose of the new file here
 
-L<Math::BigInt> has been upgraded from version 1.999727 to 1.999806.
+=head2 Changes to Existing Documentation
 
-=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.
+
+=head3 L<XXX>
 
-L<Math::BigInt::FastCalc> has been upgraded from version 0.42 to 0.5005.
+=over 4
 
 =item *
 
-L<Math::BigRat> has been upgraded from version 0.260804 to 0.2611.
+XXX Description of the change here
 
-=item *
+=back
 
-L<Module::CoreList> has been upgraded from version 5.20161120 to 5.20161220.
+=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>.
+
+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.
 
-L<PerlIO::scalar> has been upgraded from version 0.24 to 0.25.
+=head2 New Diagnostics
+
+XXX Newly added diagnostic messages go under here, separated into New Errors
+and New Warnings
+
+=head3 New Errors
+
+=over 4
 
 =item *
 
-L<Pod::Simple> has been upgraded from version 3.32 to 3.35.
+XXX L<message|perldiag/"message">
+
+=back
+
+=head3 New Warnings
+
+=over 4
 
 =item *
 
-L<POSIX> has been upgraded from version 1.75 to 1.76.
+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<Test::Simple> has been upgraded from version 1.302062 to 1.302073.
+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 *
 
-L<Time::HiRes> has been upgraded from version 1.9740_03 to 1.9741.
+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 a =item entry ].
+
+=over 4
 
 =item *
 
-L<Time::Local> has been upgraded from version 1.24 to 1.25.
+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.
+
+[ List each test improvement as a =item entry ]
+
+=over 4
 
 =item *
 
-L<Unicode::Collate> has been upgraded from version 1.18 to 1.19.
+XXX
 
 =back
 
-=head1 Configuration and Compilation
+=head1 Platform Support
+
+XXX Any changes to platform support should be listed in the sections below.
+
+[ Within the sections, list each platform as a =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 a =item entry ]
 
 =over 4
 
 =item *
 
-Zero out the alignment bytes when calculating the bytes for 80-bit C<NaN>
-and C<Inf> to make builds more reproducible. [perl #130133]
+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 a =item entry ]
+
+=over 4
 
 =item *
 
-Since 5.18 for testing purposes we have included support for
-building perl with a variety of non-standard, and non-recommended
-hash functions. Since we do not recommend the use of these functions
-we have removed them and their corresponding build options. Specifically
-this includes the following build options:
+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.
 
-    PERL_HASH_FUNC_SDBM
-    PERL_HASH_FUNC_DJB2
-    PERL_HASH_FUNC_SUPERFAST
-    PERL_HASH_FUNC_MURMUR3
-    PERL_HASH_FUNC_ONE_AT_A_TIME
-    PERL_HASH_FUNC_ONE_AT_A_TIME_OLD
-    PERL_HASH_FUNC_MURMUR_HASH_64A
-    PERL_HASH_FUNC_MURMUR_HASH_64B
+[ List each fix as a =item entry ]
+
+=over 4
+
+=item *
+
+XXX
 
 =back
 
-=head1 Acknowledgements
+=head1 Errata From Previous Releases
+
+=over 4
 
-Perl 5.25.8 represents approximately 4 weeks of development since Perl 5.25.7
-and contains approximately 21,000 lines of changes across 500 files from 19
-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 18,000 lines of changes to 340 .pm, .t, .c and .h files.
+=back
 
-Perl continues to flourish into its third decade thanks to a vibrant community
-of users and developers. The following people are known to have contributed the
-improvements that became Perl 5.25.8:
+=head1 Obituary
 
-Andy Lester, Aristotle Pagaltzis, Chad Granum, Chris 'BinGOs' Williams,
-Christian Hansen, Craig A. Berry, David Mitchell, Hugo van der Sanden, James E
-Keenan, J. Nick Koston, Karl Williamson, Matthew Horsfall, Niko Tyni, Petr
-Písař, Sawyer X, Steve Hay, Sullivan Beck, Tony Cook, Yves Orton.
+XXX If any significant core contributor has died, we've added 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.25.5..HEAD
 
 =head1 Reporting Bugs