summaryrefslogtreecommitdiff
path: root/pod/perldelta.pod
diff options
context:
space:
mode:
Diffstat (limited to 'pod/perldelta.pod')
-rw-r--r--pod/perldelta.pod366
1 files changed, 292 insertions, 74 deletions
diff --git a/pod/perldelta.pod b/pod/perldelta.pod
index bc94ddfbc0..07409956fb 100644
--- a/pod/perldelta.pod
+++ b/pod/perldelta.pod
@@ -2,76 +2,163 @@
=head1 NAME
-perldelta - what is new for perl v5.26.3
+[ 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.26.4
=head1 DESCRIPTION
-This document describes differences between the 5.26.2 release and the 5.26.3
+This document describes differences between the 5.26.3 release and the 5.26.4
release.
-If you are upgrading from an earlier release such as 5.26.1, first read
-L<perl5262delta>, which describes differences between 5.26.1 and 5.26.2.
+If you are upgrading from an earlier release such as 5.26.2, first read
+L<perl5263delta>, which describes differences between 5.26.2 and 5.26.3.
+
+=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
-=head2 [CVE-2018-12015] Directory traversal in module Archive::Tar
+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.
-By default, L<Archive::Tar> doesn't allow extracting files outside the current
-working directory. However, this secure extraction mode could be bypassed by
-putting a symlink and a regular file with the same name into the tar file.
+[ List each security issue as a =head2 entry ]
-L<[perl #133250]|https://rt.perl.org/Ticket/Display.html?id=133250>
-L<[cpan #125523]|https://rt.cpan.org/Ticket/Display.html?id=125523>
+=head1 Incompatible Changes
-=head2 [CVE-2018-18311] Integer overflow leading to buffer overflow and segmentation fault
+XXX For a release on a stable branch, this section aspires to be:
-Integer arithmetic in C<Perl_my_setenv()> could wrap when the combined length
-of the environment variable name and value exceeded around 0x7fffffff. This
-could lead to writing beyond the end of an allocated buffer with attacker
-supplied data.
+ 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.
-L<[perl #133204]|https://rt.perl.org/Ticket/Display.html?id=133204>
+[ List each incompatible change as a =head2 entry ]
-=head2 [CVE-2018-18312] Heap-buffer-overflow write in S_regatom (regcomp.c)
+=head1 Deprecations
-A crafted regular expression could cause heap-buffer-overflow write during
-compilation, potentially allowing arbitrary code execution.
+XXX Any deprecated features, syntax, modules etc. should be listed here.
-L<[perl #133423]|https://rt.perl.org/Ticket/Display.html?id=133423>
+=head2 Module removals
-=head2 [CVE-2018-18313] Heap-buffer-overflow read in S_grok_bslash_N (regcomp.c)
+XXX Remove this section if inapplicable.
-A crafted regular expression could cause heap-buffer-overflow read during
-compilation, potentially leading to sensitive information being leaked.
+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.
-L<[perl #133192]|https://rt.perl.org/Ticket/Display.html?id=133192>
+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 [CVE-2018-18314] Heap-buffer-overflow write in S_regatom (regcomp.c)
+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.
-A crafted regular expression could cause heap-buffer-overflow write during
-compilation, potentially allowing arbitrary code execution.
+=over
-L<[perl #131649]|https://rt.perl.org/Ticket/Display.html?id=131649>
+=item XXX
-=head1 Incompatible Changes
+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
-There are no changes intentionally incompatible with 5.26.2. If any exist,
-they are bugs, and we request that you submit a report. See
-L</Reporting Bugs> below.
+[ 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 a =item entry ]
+
+=over 4
+
+=item *
+
+XXX
+
+=back
=head1 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 *
+
+XXX
+
+=back
+
=head2 Updated Modules and Pragmata
=over 4
=item *
-L<Archive::Tar> has been upgraded from version 2.24 to 2.24_01.
+L<XXX> has been upgraded from version A.xx to B.yy.
+
+=back
+
+=head2 Removed Modules and Pragmata
+
+=over 4
=item *
-L<Module::CoreList> has been upgraded from version 5.20180414_26 to 5.20181129_26.
+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
+
+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>
+
+=over 4
+
+=item *
+
+XXX Description of the change here
=back
@@ -81,86 +168,217 @@ 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 *
-L<Unexpected ']' with no following ')' in (?[... in regex; marked by E<lt>-- HERE in mE<sol>%sE<sol>|perldiag/"Unexpected ']' with no following ')' in (?[... in regex; marked by E<lt>-- HERE in mE<sol>%sE<sol>">
+XXX L<message|perldiag/"message">
+
+=back
+
+=head3 New Warnings
-(F) While parsing an extended character class a ']' character was encountered
-at a point in the definition where the only legal use of ']' is to close the
-character class definition as part of a '])', you may have forgotten the close
-paren, or otherwise confused the parser.
+=over 4
=item *
-L<Expecting close paren for nested extended charclass in regex; marked by E<lt>-- HERE in mE<sol>%sE<sol>|perldiag/"Expecting close paren for nested extended charclass in regex; marked by E<lt>-- HERE in mE<sol>%sE<sol>">
+XXX L<message|perldiag/"message">
-(F) While parsing a nested extended character class like:
+=back
- (?[ ... (?flags:(?[ ... ])) ... ])
- ^
+=head2 Changes to Existing Diagnostics
-we expected to see a close paren ')' (marked by ^) but did not.
+XXX Changes (i.e. rewording) of diagnostic messages go here
+
+=over 4
=item *
-L<Expecting close paren for wrapper for nested extended charclass in regex; marked by E<lt>-- HERE in mE<sol>%sE<sol>|perldiag/"Expecting close paren for wrapper for nested extended charclass in regex; marked by E<lt>-- HERE in mE<sol>%sE<sol>">
+XXX Describe change here
+
+=back
+
+=head1 Utility Changes
-(F) While parsing a nested extended character class like:
+XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
+Most of these are built within the directory F<utils>.
- (?[ ... (?flags:(?[ ... ])) ... ])
- ^
+[ 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. ]
-we expected to see a close paren ')' (marked by ^) but did not.
+=head2 L<XXX>
+
+=over 4
+
+=item *
+
+XXX
=back
-=head2 Changes to Existing Diagnostics
+=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<Syntax error in (?[...]) in regex; marked by E<lt>-- HERE in mE<sol>%sE<sol>|perldiag/"Syntax error in (?[...]) in regex; marked by E<lt>-- HERE in mE<sol>%sE<sol>">
+XXX
-This fatal error message has been slightly expanded (from "Syntax error in
-(?[...]) in regex mE<sol>%sE<sol>") for greater clarity.
+=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 *
+
+XXX
=back
-=head1 Acknowledgements
+=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
-Perl 5.26.3 represents approximately 8 months of development since Perl 5.26.2
-and contains approximately 4,500 lines of changes across 51 files from 15
-authors.
+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.
-Excluding auto-generated files, documentation and release tools, there were
-approximately 770 lines of changes to 10 .pm, .t, .c and .h files.
+[ List each change as a =item entry ]
-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.26.3:
+=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 a =item entry ]
+
+=over 4
+
+=item *
+
+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.
-Aaron Crane, Abigail, Chris 'BinGOs' Williams, Dagfinn Ilmari Mannsåker, David
-Mitchell, H.Merijn Brand, James E Keenan, John SJ Anderson, Karen Etheridge,
-Karl Williamson, Sawyer X, Steve Hay, Todd Rinaldo, Tony Cook, Yves Orton.
+[ List each fix as a =item entry ]
-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.
+=over 4
+
+=item *
+
+XXX
+
+=back
+
+=head1 Errata From Previous Releases
+
+=over 4
+
+=item *
+
+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 has died, we've added 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.26.3..HEAD
=head1 Reporting Bugs