create perldelta for 5.14.5
authorDavid Mitchell <davem@iabyn.com>
Mon, 11 Mar 2013 00:26:44 +0000 (00:26 +0000)
committerDavid Mitchell <davem@iabyn.com>
Mon, 11 Mar 2013 00:26:44 +0000 (00:26 +0000)
pod/.gitignore
pod/perl5144delta.pod [new file with mode: 0644]
pod/perldelta.pod

index 52b8366..5288d22 100644 (file)
@@ -58,6 +58,6 @@
 /podselect.bat
 
 # generated
-/perl5144delta.pod
+/perl5145delta.pod
 /perlapi.pod
 /perlintern.pod
diff --git a/pod/perl5144delta.pod b/pod/perl5144delta.pod
new file mode 100644 (file)
index 0000000..23deecb
--- /dev/null
@@ -0,0 +1,240 @@
+=encoding utf8
+
+=head1 NAME
+
+perl5144delta - what is new for perl v5.14.4
+
+=head1 DESCRIPTION
+
+This document describes differences between the 5.14.3 release and
+the 5.14.4 release.
+
+If you are upgrading from an earlier release such as 5.12.0, first read
+L<perl5140delta>, which describes differences between 5.12.0 and
+5.14.0.
+
+=head1 Core Enhancements
+
+No changes since 5.14.0.
+
+=head1 Security
+
+This release contains one major, and medium, and a number of minor
+security fixes.  The latter are included mainly to allow the test suite to
+pass cleanly with the clang compiler's address sanitizer facility.
+
+=head2 CVE-2013-1667: memory exhaustion with arbitrary hash keys
+
+With a carefully crafted set of hash keys (for example arguments on a
+URL), it is possible to cause a hash to consume a large amount of memory
+and CPU, and thus possibly to achieve a Denial-of-Service.
+
+This problem has been fixed.
+
+=head2 memory leak in Encode
+
+The UTF-8 encoding implementation in Encode.xs had a memory leak which has been
+fixed.
+
+=head2 [perl #111594] Socket::unpack_sockaddr_un heap-buffer-overflow
+
+A read buffer overflow could occur when copying C<sockaddr> buffers.
+Fairly harmless.
+
+This problem has been fixed.
+
+=head2 [perl #111586] SDBM_File: fix off-by-one access to global ".dir"
+
+An extra byte was being copied for some string literals. Fairly harmless.
+
+This problem has been fixed.
+
+=head2 off-by-two error in List::Util
+
+A string literal was being used that included two bytes beyond the
+end of the string. Fairly harmless.
+
+This problem has been fixed.
+
+=head2 [perl #115994] fix segv in regcomp.c:S_join_exact()
+
+Under debugging builds, while marking optimised-out regex nodes as type
+C<OPTIMIZED>, it could treat blocks of exact text as if they were nodes,
+and thus SEGV. Fairly harmless.
+
+This problem has been fixed.
+
+=head2 [perl #115992] PL_eval_start use-after-free
+
+The statement C<local $[;>, when preceded by an C<eval>, and when not part
+of an assignment, could crash. Fairly harmless.
+
+This problem has been fixed.
+
+=head2 wrap-around with IO on long strings
+
+Reading or writing strings greater than 2**31 bytes in size could segfault
+due to integer wraparound.
+
+This problem has been fixed.
+
+=head1 Incompatible Changes
+
+There are no changes intentionally incompatible with 5.14.0. If any
+exist, they are bugs and reports are welcome.
+
+=head1 Deprecations
+
+There have been no deprecations since 5.14.0.
+
+=head1 Modules and Pragmata
+
+=head2 New Modules and Pragmata
+
+None
+
+=head2 Updated Modules and Pragmata
+
+The following modules have just the minor code fixes as listed above in
+L</Security> (version numbers have not changed):
+
+=over 4
+
+=item Socket
+
+=item SDBM_File
+
+=item List::Util
+
+=back
+
+L<Encode> has been upgraded from version 2.42_01 to version 2.42_02.
+
+L<Module::CoreList> has been updated to version 2.49_06 to add data for
+this release.
+
+=head2 Removed Modules and Pragmata
+
+None.
+
+=head1 Documentation
+
+=head2 New Documentation
+
+None.
+
+=head2 Changes to Existing Documentation
+
+None.
+
+=head1 Diagnostics
+
+No new or changed diagnostics.
+
+=head1 Utility Changes
+
+None
+
+=head1 Configuration and Compilation
+
+No changes.
+
+=head1 Platform Support
+
+=head2 New Platforms
+
+None.
+
+=head2 Discontinued Platforms
+
+None.
+
+=head2 Platform-Specific Notes
+
+=over 4
+
+=item VMS
+
+5.14.3 failed to compile on VMS due to incomplete application of a patch
+series that allowed C<userelocatableinc> and C<usesitecustomize> to be
+used simultaneously.  Other platforms were not affected and the problem
+has now been corrected.
+
+=back
+
+=head1 Selected Bug Fixes
+
+=over 4
+
+=item *
+
+In Perl 5.14.0, C<$tainted ~~ @array> stopped working properly.  Sometimes
+it would erroneously fail (when C<$tainted> contained a string that occurs
+in the array I<after> the first element) or erroneously succeed (when
+C<undef> occurred after the first element) [perl #93590].
+
+=back
+
+=head1 Known Problems
+
+None.
+
+=head1 Acknowledgements
+
+Perl 5.14.4 represents approximately 5 months of development since Perl 5.14.3
+and contains approximately 1,700 lines of changes across 49 files from 12
+authors.
+
+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.14.4:
+
+Andy Dougherty, Chris 'BinGOs' Williams, Christian Hansen, Craig A. Berry,
+Dave Rolsky, David Mitchell, Dominic Hargreaves, Father Chrysostomos,
+Florian Ragwitz, Reini Urban, Ricardo Signes, Yves Orton.
+
+
+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.
+
+For a more complete list of all of Perl's historical contributors, please see
+the F<AUTHORS> file in the Perl source distribution.
+
+
+=head1 Reporting Bugs
+
+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 http://rt.perl.org/perlbug/ .  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<perlbug>
+program included with your release.  Be sure to trim your bug down
+to a tiny but sufficient test case.  Your bug report, along with the
+output of C<perl -V>, will be sent off to perlbug@perl.org to be
+analysed by the Perl porting team.
+
+If the bug you are reporting has security implications, which make it
+inappropriate to send to a publicly archived mailing list, then please send
+it to perl5-security-report@perl.org. This points to a closed subscription
+unarchived mailing list, which includes all the core committers, who be able
+to help assess the impact of issues, figure out a resolution, and help
+co-ordinate the release of patches to mitigate or fix the problem across all
+platforms on which Perl is supported. Please only use this address for
+security issues in the Perl core, not for modules independently
+distributed on CPAN.
+
+=head1 SEE ALSO
+
+The F<Changes> file for an explanation of how to view exhaustive details
+on what changed.
+
+The F<INSTALL> file for how to build Perl.
+
+The F<README> file for general stuff.
+
+The F<Artistic> and F<Copying> files for copyright information.
+
+=cut
index 68cf653..3121bc8 100644 (file)
 
 =head1 NAME
 
-perldelta - what is new for perl v5.14.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.14.5
 
 =head1 DESCRIPTION
 
-This document describes differences between the 5.14.3 release and
-the 5.14.4 release.
+This document describes differences between the 5.14.4 release and
+the 5.14.5 release.
 
-If you are upgrading from an earlier release such as 5.12.0, first read
+If you are upgrading from an earlier release such as 5.12.5, first read
 L<perl5140delta>, which describes differences between 5.12.0 and
 5.14.0.
 
+=head1 Notice
+
+XXX Any important notices here
+
 =head1 Core Enhancements
 
-No changes since 5.14.0.
+XXX New core language features go here. Summarise 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
 
-This release contains one major, and medium, and a number of minor
-security fixes.  The latter are included mainly to allow the test suite to
-pass cleanly with the clang compiler's address sanitizer facility.
+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.
 
-=head2 CVE-2013-1667: memory exhaustion with arbitrary hash keys
+[ List each security issue as a =head2 entry ]
 
-With a carefully crafted set of hash keys (for example arguments on a
-URL), it is possible to cause a hash to consume a large amount of memory
-and CPU, and thus possibly to achieve a Denial-of-Service.
+=head1 Incompatible Changes
 
-This problem has been fixed.
+XXX For a release on a stable branch, this section aspires to be:
 
-=head2 memory leak in Encode
+    There are no changes intentionally incompatible with 5.14.0. If any
+    exist, they are bugs and reports are welcome.
 
-The UTF-8 encoding implementation in Encode.xs had a memory leak which has been
-fixed.
+[ List each incompatible change as a =head2 entry ]
 
-=head2 [perl #111594] Socket::unpack_sockaddr_un heap-buffer-overflow
+=head1 Deprecations
 
-A read buffer overflow could occur when copying C<sockaddr> buffers.
-Fairly harmless.
+XXX Any deprecated features, syntax, modules etc. should be listed here.
+In particular, deprecated modules should be listed here even if they are
+listed as an updated module in the L</Modules and Pragmata> section.
 
-This problem has been fixed.
+[ List each deprecation as a =head2 entry ]
 
-=head2 [perl #111586] SDBM_File: fix off-by-one access to global ".dir"
+=head1 Performance Enhancements
 
-An extra byte was being copied for some string literals. Fairly harmless.
+XXX Changes which enhance performance without changing behaviour go here. There
+may well be none in a stable release.
 
-This problem has been fixed.
+[ List each enhancement as a =item entry ]
 
-=head2 off-by-two error in List::Util
+=over 4
 
-A string literal was being used that included two bytes beyond the
-end of the string. Fairly harmless.
+=item *
 
-This problem has been fixed.
+XXX
 
-=head2 [perl #115994] fix segv in regcomp.c:S_join_exact()
+=back
 
-Under debugging builds, while marking optimised-out regex nodes as type
-C<OPTIMIZED>, it could treat blocks of exact text as if they were nodes,
-and thus SEGV. Fairly harmless.
+=head1 Modules and Pragmata
 
-This problem has been fixed.
+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>, which prints stub
+entries to STDOUT.  Results can be pasted in place of the '=head2' entries
+below.  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.
 
-=head2 [perl #115992] PL_eval_start use-after-free
+[ Within each section, list entries as a =item entry ]
 
-The statement C<local $[;>, when preceded by an C<eval>, and when not part
-of an assignment, could crash. Fairly harmless.
+=head2 New Modules and Pragmata
 
-This problem has been fixed.
+=over 4
 
-=head2 wrap-around with IO on long strings
+=item *
 
-Reading or writing strings greater than 2**31 bytes in size could segfault
-due to integer wraparound.
+XXX
 
-This problem has been fixed.
+=back
 
-=head1 Incompatible Changes
+=head2 Updated Modules and Pragmata
 
-There are no changes intentionally incompatible with 5.14.0. If any
-exist, they are bugs and reports are welcome.
+=over 4
 
-=head1 Deprecations
+=item *
 
-There have been no deprecations since 5.14.0.
+XXX
 
-=head1 Modules and Pragmata
+=back
 
-=head2 New Modules and Pragmata
+=head2 Removed Modules and Pragmata
 
-None
+=over 4
 
-=head2 Updated Modules and Pragmata
+=item *
 
-The following modules have just the minor code fixes as listed above in
-L</Security> (version numbers have not changed):
+XXX
 
-=over 4
+=back
+
+=head1 Documentation
 
-=item Socket
+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>.
 
-=item SDBM_File
+=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
 
-=item List::Util
+=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
 
-L<Encode> has been upgraded from version 2.42_01 to version 2.42_02.
+=head1 Diagnostics
 
-L<Module::CoreList> has been updated to version 2.49_06 to add data for
-this release.
+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>.
 
-=head2 Removed Modules and Pragmata
+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.
 
-None.
+[ Within each section, list entries as a =item entry ]
 
-=head1 Documentation
+=head2 New Diagnostics
 
-=head2 New Documentation
+XXX Newly added diagnostic messages go here
 
-None.
+=over 4
 
-=head2 Changes to Existing Documentation
+=item *
 
-None.
+XXX
 
-=head1 Diagnostics
+=back
 
-No new or changed diagnostics.
+=head2 Changes to Existing Diagnostics
+
+XXX Changes (i.e. rewording) of diagnostic messages go here
+
+=over 4
+
+=item *
+
+XXX
+
+=back
 
 =head1 Utility Changes
 
-None
+XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
+here. Most of these are built within the directories F<utils> and F<x2p>.
+
+[ List utility changes as a =head3 entry for each utility and =item
+entries for each change
+Use L<XXX> with program names to get proper documentation linking. ]
+
+=head3 L<XXX>
+
+=over 4
+
+=item *
+
+XXX
+
+=back
 
 =head1 Configuration and Compilation
 
-No changes.
+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 summarising, 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
 
-None.
+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
 
-None.
+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 test improvement as a =item entry ]
+
 =over 4
 
-=item VMS
+=item *
 
-5.14.3 failed to compile on VMS due to incomplete application of a patch
-series that allowed C<userelocatableinc> and C<usesitecustomize> to be
-used simultaneously.  Other platforms were not affected and the problem
-has now been corrected.
+XXX
 
 =back
 
 =head1 Selected Bug Fixes
 
+XXX Important bug fixes in the core language are summarised here.
+Bug fixes in files in F<ext/> and F<lib/> are best summarised in
+L</Modules and Pragmata>.
+
+[ List each fix as a =item entry ]
+
 =over 4
 
 =item *
 
-In Perl 5.14.0, C<$tainted ~~ @array> stopped working properly.  Sometimes
-it would erroneously fail (when C<$tainted> contained a string that occurs
-in the array I<after> the first element) or erroneously succeed (when
-C<undef> occurred after the first element) [perl #93590].
+XXX
 
 =back
 
 =head1 Known Problems
 
-None.
+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, unless
+they were specific to a particular platform (see below).
 
-=head1 Acknowledgements
+This is a list of some significant unfixed bugs, which are regressions
+from either 5.XXX.XXX or 5.XXX.XXX.
 
-Perl 5.14.4 represents approximately 5 months of development since Perl 5.14.3
-and contains approximately 1,700 lines of changes across 49 files from 12
-authors.
+[ List each fix 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.14.4:
+=over 4
 
-Andy Dougherty, Chris 'BinGOs' Williams, Christian Hansen, Craig A. Berry,
-Dave Rolsky, David Mitchell, Dominic Hargreaves, Father Chrysostomos,
-Florian Ragwitz, Reini Urban, Ricardo Signes, Yves Orton.
+=item *
 
+XXX
 
-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
 
-For a more complete list of all of Perl's historical contributors, please see
-the F<AUTHORS> file in the Perl source distribution.
+=head1 Obituary
+
+XXX If any significant core contributor has died, we've added a short obituary
+here.
+
+=head1 Acknowledgements
 
+XXX The list of people to thank goes here.
 
 =head1 Reporting Bugs