This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for commit 6f669bf58b
[perl5.git] / pod / perldelta.pod
index b30c767..de2ba9c 100644 (file)
 
 =head1 NAME
 
-perldelta - what is new for perl v5.27.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.27.7
 
 =head1 DESCRIPTION
 
-This document describes differences between the 5.27.4 release and the 5.27.5
+This document describes differences between the 5.27.6 release and the 5.27.7
 release.
 
-If you are upgrading from an earlier release such as 5.27.3, first read
-L<perl5274delta>, which describes differences between 5.27.3 and 5.27.4.
+If you are upgrading from an earlier release such as 5.27.5, first read
+L<perl5276delta>, which describes differences between 5.27.5 and 5.27.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
+
+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 L<Locale::Codes> and its associated Country, Currency and Language modules
+
+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 *
 
-Calls to C<require> for an already loaded module are now slightly faster.
-L<[perl #132171]|https://rt.perl.org/Public/Bug/Display.html?id=132171>
+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.
+
+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.)
+
+[ Within each section, list entries as an =item entry ]
+
+=head2 New Modules and Pragmata
 
 =over 4
 
 =item *
 
-L<arybase> has been upgraded from version 0.13 to 0.14.
+XXX Remove this section if not applicable.
 
-=item *
+=back
 
-L<B> has been upgraded from version 1.69 to 1.70.
+=head2 Updated Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<B::Concise> has been upgraded from version 1.001 to 1.002.
+L<Locale::Codes> has been upgraded from version 3.54 to 3.55
 
-=item *
+B<NOTE>: L<Locale::Codes> is deprecated in core and will be removed
+from Perl 5.30.
 
-L<B::Deparse> has been upgraded from version 1.42 to 1.43.
+=back
 
-=item *
+=head2 Removed Modules and Pragmata
 
-L<Config::Perl::V> has been upgraded from version 0.28 to 0.29.
+=over 4
 
 =item *
 
-L<Digest::SHA> has been upgraded from version 5.96 to 5.98.
+XXX
 
-=item *
+=back
 
-L<Encode> has been upgraded from version 2.92 to 2.93.
+=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<encoding> has been upgraded from version 2.20 to 2.21.
+=head2 New Documentation
 
-=item *
+XXX Changes which create B<new> files in F<pod/> go here.
 
-L<File::Fetch> has been upgraded from version 0.52 to 0.54.
+=head3 L<XXX>
 
-=item *
+XXX Description of the purpose of the new file here
 
-L<File::Path> has been upgraded from version 2.14 to 2.15.
+=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<List::Util> has been upgraded from version 1.48 to 1.49.
+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<Locale::Codes> has been upgraded from version 3.52 to 3.54.
+=head3 L<XXX>
+
+=over 4
 
 =item *
 
-L<Math::BigInt> has been upgraded from version 1.999806 to 1.999811.
+XXX Description of the change here
 
-=item *
+=back
 
-L<Math::BigInt::FastCalc> has been upgraded from version 0.5005 to 0.5006.
+=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.20170920 to 5.20171020.
+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<NEXT> has been upgraded from version 0.67 to 0.67_01.
+XXX Newly added diagnostic messages go under here, separated into New Errors
+and New Warnings
 
-=item *
+=head3 New Errors
 
-L<Pod::Perldoc> has been upgraded from version 3.28 to 3.2801.
+=over 4
 
 =item *
 
-L<POSIX> has been upgraded from version 1.77 to 1.78.
+XXX L<message|perldiag/"message">
 
-=item *
+=back
+
+=head3 New Warnings
 
-L<Scalar::Util> has been upgraded from version 1.48 to 1.49.
+=over 4
 
 =item *
 
-L<Sub::Util> has been upgraded from version 1.48 to 1.49.
+L<Old package separator used in string|perldiag/"Old package separator used in string">
+
+(W syntax) You used the old package separator, "'", in a variable
+named inside a double-quoted string; e.g., C<"In $name's house">.  This
+is equivalent to C<"In $name::s house">.  If you meant the former, put
+a backslash before the apostrophe (C<"In $name\'s house">).
+
+=back
+
+=head2 Changes to Existing Diagnostics
+
+XXX Changes (i.e. rewording) of diagnostic messages go here
+
+=over 4
 
 =item *
 
-L<Sys::Hostname> has been upgraded from version 1.20 to 1.21.
+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<Test::Simple> has been upgraded from version 1.302073 to 1.302103.
+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 *
 
-L<Time::HiRes> has been upgraded from version 1.9743 to 1.9746.
+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 *
 
-L<Time::Piece> has been upgraded from version 1.3201 to 1.3202.
+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 CentOS
+=item Windows
 
-Compilation on CentOS 5 is now fixed.
+We now set C<$Config{libpth}> correctly for 64-bit builds using Visual C++
+versions earlier than 14.1.
 
 =back
 
-=head1 Selected Bug Fixes
+=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 *
 
-Calling L<exec PROGRAM LIST|perlfunc/exec PROGRAM LIST> with an empty C<LIST>
-has been fixed.  This should call C<execvp()> with an empty C<argv> array
-(containing only the terminating C<NULL> pointer), but was instead just
-returning false (and not setting L<C<$!>|perlvar/$!>).
-L<[perl #131730]|https://rt.perl.org/Public/Bug/Display.html?id=131730>
+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 C<gv_fetchmeth_sv> C function stopped working properly in Perl 5.22 when
-fetching a constant with a UTF-8 name if that constant subroutine was stored in
-the stash as a simple scalar reference, rather than a full typeglob.  This has
-been corrected.
+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 *
 
-Single-letter debugger commands followed by an argument which starts with
-punctuation  (e.g. C<p$^V> and C<x@ARGV>) now work again.  They had been
-wrongly requiring a space between the command and the argument.
-L<[perl #120174]|https://rt.perl.org/Public/Bug/Display.html?id=120174>
+XXX
+
+=back
+
+=head1 Errata From Previous Releases
+
+=over 4
 
 =item *
 
-L<splice|perlfunc/splice ARRAY,OFFSET,LENGTH,LIST> now throws an exception
-("Modification of a read-only value attempted") when modifying a read-only
-array.  Until now it had been silently modifying the array.  The new behaviour
-is consistent with the behaviour of L<push|perlfunc/push ARRAY,LIST> and
-L<unshift|perlfunc/unshift ARRAY,LIST>.
-L<[perl #131000]|https://rt.perl.org/Public/Bug/Display.html?id=131000>
+XXX Add anything here that we forgot to add, or were mistaken about, in
+the perldelta of a previous release.
 
 =back
 
+=head1 Obituary
+
+XXX If any significant core contributor or member of the CPAN community has
+died, add a short obituary here.
+
 =head1 Acknowledgements
 
 XXX Generate this with:
 
-  perl Porting/acknowledgements.pl v5.25.5..HEAD
+  perl Porting/acknowledgements.pl v5.27.6..HEAD
 
 =head1 Reporting Bugs