diff options
Diffstat (limited to 'pod/perldelta.pod')
| -rw-r--r-- | pod/perldelta.pod | 383 |
1 files changed, 332 insertions, 51 deletions
diff --git a/pod/perldelta.pod b/pod/perldelta.pod index 1896cc2b0a..6a35aaccb0 100644 --- a/pod/perldelta.pod +++ b/pod/perldelta.pod @@ -2,102 +2,383 @@ =head1 NAME -perldelta - what is new for perl v5.24.4 +[ 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.24.5 =head1 DESCRIPTION -This document describes differences between the 5.24.3 release and the 5.24.4 +This document describes differences between the 5.24.4 release and the 5.24.5 release. -If you are upgrading from an earlier release such as 5.24.2, first read -L<perl5243delta>, which describes differences between 5.24.2 and 5.24.3. +If you are upgrading from an earlier release such as 5.24.3, first read +L<perl5244delta>, which describes differences between 5.24.3 and 5.24.4. + +=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-6797] heap-buffer-overflow (WRITE of size 1) in S_regatom (regcomp.c) +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. -A crafted regular expression could cause a heap buffer write overflow, with -control over the bytes written. -L<[perl #132227]|https://rt.perl.org/Public/Bug/Display.html?id=132227> +[ List each security issue as a =head2 entry ] -=head2 [CVE-2018-6798] Heap-buffer-overflow in Perl__byte_dump_string (utf8.c) +=head1 Incompatible Changes -Matching a crafted locale dependent regular expression could cause a heap -buffer read overflow and potentially information disclosure. -L<[perl #132063]|https://rt.perl.org/Public/Bug/Display.html?id=132063> +XXX For a release on a stable branch, this section aspires to be: -=head2 [CVE-2018-6913] heap-buffer-overflow in S_pack_rec + 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. -C<pack()> could cause a heap buffer write overflow with a large item count. -L<[perl #131844]|https://rt.perl.org/Public/Bug/Display.html?id=131844> +[ List each incompatible change as a =head2 entry ] -=head2 Assertion failure in Perl__core_swash_init (utf8.c) +=head1 Deprecations -Control characters in a supposed Unicode property name could cause perl to -crash. This has been fixed. -L<[perl #132055]|https://rt.perl.org/Public/Bug/Display.html?id=132055> -L<[perl #132553]|https://rt.perl.org/Public/Bug/Display.html?id=132553> -L<[perl #132658]|https://rt.perl.org/Public/Bug/Display.html?id=132658> +XXX Any deprecated features, syntax, modules etc. should be listed here. -=head1 Incompatible Changes +=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. -There are no changes intentionally incompatible with 5.24.3. If any exist, -they are bugs, and we request that you submit a report. See L</Reporting -Bugs> below. +=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 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<Module::CoreList> has been upgraded from version 5.20170922_24 to 5.20180414_24. +L<XXX> has been upgraded from version A.xx to B.yy. + +=back + +=head2 Removed Modules and Pragmata + +=over 4 + +=item * + +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 + +=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 a =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. + +[ List each test improvement as a =item entry ] + +=over 4 + +=item * + +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 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 * + +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 * -The C<readpipe()> built-in function now checks at compile time that it has only -one parameter expression, and puts it in scalar context, thus ensuring that it -doesn't corrupt the stack at runtime. -L<[perl #4574]|https://rt.perl.org/Public/Bug/Display.html?id=4574> +XXX =back -=head1 Acknowledgements +=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 a =item entry ] + +=over 4 + +=item * + +XXX + +=back -Perl 5.24.4 represents approximately 7 months of development since Perl 5.24.3 -and contains approximately 2,400 lines of changes across 49 files from 12 -authors. +=head1 Errata From Previous Releases -Excluding auto-generated files, documentation and release tools, there were -approximately 1,300 lines of changes to 12 .pm, .t, .c and .h files. +=over 4 -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.24.4: +=item * -Abigail, Chris 'BinGOs' Williams, John SJ Anderson, Karen Etheridge, Karl -Williamson, Renee Baecker, Sawyer X, Steve Hay, Todd Rinaldo, Tony Cook, Yves -Orton, Zefram. +XXX Add anything here that we forgot to add, or were mistaken about, in +the perldelta of a previous release. -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. +=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.24.4..HEAD =head1 Reporting Bugs |