From ca3178e0ad8db63501396e99ca174e2bc98da1e4 Mon Sep 17 00:00:00 2001 From: Steve Hay Date: Fri, 18 Apr 2014 13:36:52 +0100 Subject: [PATCH] perldelta - Update, remove boilerplates, and do some copy-editing Also update the template for utilities: a =head3 doesn't look right directly under a =head1 so make it a =head2 instead. --- Porting/perldelta_template.pod | 4 +- pod/perldelta.pod | 363 ++++++----------------------------------- 2 files changed, 56 insertions(+), 311 deletions(-) diff --git a/Porting/perldelta_template.pod b/Porting/perldelta_template.pod index d68e108..70838c6 100644 --- a/Porting/perldelta_template.pod +++ b/Porting/perldelta_template.pod @@ -213,11 +213,11 @@ XXX Describe change here XXX Changes to installed programs such as F and F go here. Most of these are built within the directories F and F. -[ List utility changes as a =head3 entry for each utility and =item +[ List utility changes as a =head2 entry for each utility and =item entries for each change Use L with program names to get proper documentation linking. ] -=head3 L +=head2 L =over 4 diff --git a/pod/perldelta.pod b/pod/perldelta.pod index 44b5bcf..29b787b 100644 --- a/pod/perldelta.pod +++ b/pod/perldelta.pod @@ -6,9 +6,6 @@ =head1 NAME -[ 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.19.11 =head1 DESCRIPTION @@ -19,101 +16,18 @@ release. If you are upgrading from an earlier release such as 5.19.9, first read L, which describes differences between 5.19.9 and 5.19.10. -=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 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 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 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. - -=over - -=item XXX - -XXX Note that deprecated modules should be listed here even if they are listed -as an updated module in the L 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, F, F and F -go here. If Module::CoreList is updated, generate an initial draft of the -following sections using F. A paragraph summary -for important changes should then be added by hand. In an ideal world, -dual-life modules would have a F file that could be cribbed. - -[ Within each section, list entries as a =item entry ] - =head2 New Modules and Pragmata =over 4 =item * -XXX +L version 0.007 has been added. + +This pragma provides an easy and convenient way to enable or disable +experimental features. =back @@ -145,7 +59,7 @@ using the pager command. =item * -L has been upgraded from version 1.63 to 1.65. +L has been upgraded from version 1.63 to 1.67. When upgrading an already-installed file, L could mess up the permissions of files if the old versions of files were hard or symbolic @@ -159,7 +73,7 @@ The MM_TEST_ROOT feature has been removed from the tests. L has been upgraded from version 6.92 to 6.94. A regression in MM_Unix.pm has been resolved. -[L<#96|https://github.com/Perl-Toolchain-Gang/ExtUtils-MakeMaker/issues/96>] +[L] =item * @@ -189,83 +103,14 @@ L. =back -=head2 Removed Modules and Pragmata - -=over 4 - -=item * - -XXX - -=back - -=head1 Documentation - -XXX Changes to files in F go here. Consider grouping entries by -file and be sure to link to the appropriate page, e.g. L. - -=head2 New Documentation - -XXX Changes which create B files in F go here. - -=head3 L - -XXX Description of the purpose of the new file here - -=head2 Changes to Existing Documentation - -XXX Changes which significantly change existing files in F go here. -However, any changes to F should go in the L -section. - -=head3 L - -=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. -XXX New or changed warnings emitted by the core's C code go here. Also -include any changes in L that reconcile it to the 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 - -=back - -=head3 New Warnings - -=over 4 - -=item * - -XXX L - -=back - =head2 Changes to Existing Diagnostics -XXX Changes (i.e. rewording) of diagnostic messages go here - =over 4 =item * @@ -278,115 +123,44 @@ that in C<\cI>, I must be a I ASCII character. =head1 Utility Changes -XXX Changes to installed programs such as F and F go here. -Most of these are built within the directories F and F. - -[ List utility changes as a =head3 entry for each utility and =item -entries for each change -Use L with program names to get proper documentation linking. ] - -=head3 L +=head2 L =over 4 =item * L has been modified to supply the report template with CRLF line -endings on Windows, resolving perl #121277. - -L now makes as few assumptions as possible about the encoding of -the report. This will likely change in the future to assume UTF-8 by default -but allow a user override. - -=back - -=head1 Configuration and Compilation - -XXX Changes to F, F, F, 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 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 files in F go here as do any -large changes to the testing harness (e.g. when parallel testing was added). -Changes to existing files in F aren't worth summarizing, although the bugs -that they represent may be covered elsewhere. - -[ List each test improvement as a =item entry ] - -=over 4 +endings on Windows. +[L] =item * -XXX +L now makes as few assumptions as possible about the encoding of the +report. This will likely change in the future to assume UTF-8 by default but +allow a user override. =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 -directories, or new subdirectories and F files at the top level of the -source tree. +=head2 Platform-Specific Notes =over 4 =item VMS -On VMS only, a check for glob metacharacters in a path returned by the C -operator has been replaced with a check for VMS wildcard characters. This -saves a significant number of unnecessary C calls such that some -simple glob operations become 60-80% faster. - -=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 section. - -=over 4 +On VMS only, a check for glob metacharacters in a path returned by the +L|perlfunc/glob> operator has been replaced with a check for VMS +wildcard characters. This saves a significant number of unnecessary +L|perlfunc/lstat> calls such that some simple glob operations become +60-80% faster. =item Win32 The time taken to build perl on Windows has been reduced quite significantly (time savings in the region of 30-40% are typically seen) by reducing the -number of, usually failing, I/O calls for each L (for -miniperl only). +number of, usually failing, I/O calls for each L|perlfunc/require> +(for B only). [L] About 15 minutes of idle sleeping was removed from running C due to @@ -396,12 +170,12 @@ test file. [L] On a perl built without psuedo-fork (psuedo-fork builds were not affected by -this bug), killing a process tree with L and a negative signal -resulted in kill() inverting the returned value. For example, if kill() killed -1 process tree PID then it returned 0 instead of 1, and if kill() was passed 2 -invalid PIDs then it returned 2 instead of 0. This has probably been the case -since the process tree kill feature was implemented on Win32. It has now been -corrected to follow the documented behaviour. +this bug), killing a process tree with L|perlfunc/kill> and a negative +signal resulted in C inverting the returned value. For example, if +C killed 1 process tree PID then it returned 0 instead of 1, and if +C was passed 2 invalid PIDs then it returned 2 instead of 0. This has +probably been the case since the process tree kill feature was implemented on +Win32. It has now been corrected to follow the documented behaviour. [L] When building a 64-bit perl, an uninitialized memory read in B, @@ -411,9 +185,9 @@ obviously B would have been completely broken.) [L] Perl can now be built with B version 4.8.1 from L. -This was previously broken due to an incorrect definition of C in -one of perl's source files. Earlier B versions were also affected when -using version 4 of the w32api package. Versions of B available from +This was previously broken due to an incorrect definition of DllMain() in one +of perl's source files. Earlier B versions were also affected when using +version 4 of the w32api package. Versions of B available from L were not affected. [L] @@ -425,48 +199,37 @@ Windows OS on an NTFS drive. =head1 Internal Changes -XXX Changes which affect the interface available to C 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 * -C is now initialized to the C locale. This affects only -C modules, as the Perl core usages always make sure this locale -category is correctly set for their purposes. C code remains -vulnerable to other code changing this category's locale. Further fixes -are planned in v5.22 to reduce these long-standing vulnerabilities. +C is now initialized to the C locale. This affects only XS +modules, as the Perl core usages always make sure this locale category is +correctly set for their purposes. XS code remains vulnerable to other code +changing this category's locale. Further fixes are planned in Perl 5.22 to +reduce these long-standing vulnerabilities. [L] =back =head1 Selected Bug Fixes -XXX Important bug fixes in the core language are summarized here. Bug fixes in -files in F and F are best summarized in L. - -[ List each fix as a =item entry ] - =over 4 =item * -A regression involving the string value of C<$!> introduced in v5.19.2 -has been reverted for v5.20. +A regression involving the string value of L|perlvar/$!> introduced in +Perl 5.19.2 has been reverted for Perl 5.20. [L] This re-breaks the bugs it fixed, -L, so -an alternative fix is planned for v5.22 +L, so an +alternative fix is planned for Perl 5.22 =item * -A regression was introduced in v5.19.10 that under some circumstances -caused C matches to falsely fail. Now fixed. +A regression was introduced in Perl 5.19.10 that under some circumstances +caused C matches to falsely fail. Now fixed. [L] =item * @@ -479,23 +242,21 @@ This has been fixed. =item * -Fixed a bug detected by valgrind where sv_pvn_force_flags() would -check SvPVX() even when the SV hadn't been upgraded to a C. -SvPVX() is only initialized when the SV is upgraded to a C or -higher. [L] +Fixed a bug detected by valgrind where sv_pvn_force_flags() would check SvPVX() +even when the SV hadn't been upgraded to a SVt_PV. SvPVX() is only initialized +when the SV is upgraded to a SVt_PV or higher. +[L] =item * -Fixed a bug in caller() introduced in 5.18.0. In some circumstances -when caller() was called on an C stack frame it would -attempt to allocate the limit of the address space minus one, which -would croak with an out of memory error, which would be caught by the -eval. A change in 5.19.1 which increased allocation sizes to allow -COW to operate more often rounded that allocation size up and wrapped -to a zero allocation size, resulting in a crash when the source string -was copied over. [L]. +Fixed a bug in L|perlfunc/caller> introduced in Perl 5.18.0. In +some circumstances when C was called on an C stack frame +it would attempt to allocate the limit of the address space minus one, which +would croak with an out of memory error, which would be caught by the eval. A +change in Perl 5.19.1 which increased allocation sizes to allow COW to operate +more often rounded that allocation size up and wrapped to a zero allocation +size, resulting in a crash when the source string was copied over. +[L]. =back @@ -512,22 +273,6 @@ L. =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 XXX Generate this with: @@ -538,8 +283,8 @@ XXX Generate this with: If you find what you think is a bug, you might check the articles recently posted to the comp.lang.perl.misc newsgroup and the perl bug database at -https://rt.perl.org/ . There may also be information at -http://www.perl.org/ , the Perl Home Page. +https://rt.perl.org/ . There may also be information at http://www.perl.org/ , +the Perl Home Page. If you believe you have an unreported bug, please run the L program included with your release. Be sure to trim your bug down to a tiny but -- 2.7.4