finalise perldelta
authorZefram <zefram@fysh.org>
Sat, 26 May 2012 12:40:28 +0000 (13:40 +0100)
committerZefram <zefram@fysh.org>
Sat, 26 May 2012 12:40:28 +0000 (13:40 +0100)
pod/perldelta.pod

index 301f6b4..ab31d75 100644 (file)
@@ -1,12 +1,7 @@
 =encoding utf8
 
-=for comment complete up to commit 80b8b050d2c6976822563e9f8edb2baa83539b12
-
 =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.17.0
 
 =head1 DESCRIPTION
@@ -18,36 +13,8 @@ If you are upgrading from an earlier release such as 5.16.0, first read
 L<perl5160delta>, which describes differences between 5.14.0 and
 5.16.0.
 
-=head1 Notice
-
-XXX Any important notices here
-
-=head1 Core Enhancements
-
-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
-
-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 ]
-
 =head2 qw(...) can no longer be used as parentheses
 
 C<qw> lists used to fool the parser into thinking they were always
@@ -71,12 +38,6 @@ documentation has not been changed to reflect it.
 
 =head1 Deprecations
 
-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.
-
-[ List each deprecation as a =head2 entry ]
-
 =head2 Unescaped braces in regexps
 
 Literal unescaped C<{> in regular expressions is now deprecated.  Every
@@ -87,11 +48,6 @@ to delimit parameters to metacharacters that currently take no parameters.
 
 =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 *
@@ -103,34 +59,10 @@ Filetest ops manage the stack in a fractionally more efficient manner.
 Globs used in a numeric context are now numerified directly in most cases,
 rather than being numerified via stringification.
 
-=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>, 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.
-
-[ 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
@@ -231,23 +163,8 @@ available under a different name: L<CPAN::Meta::Requirements>.
 
 =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<perldata>
 
 =over 4
@@ -257,10 +174,6 @@ section.
 Now explicitly documents the behaviour of hash initializer lists that
 contain duplicate keys.
 
-=item *
-
-XXX Description of the change here
-
 =back
 
 =head3 L<perldiag>
@@ -272,10 +185,6 @@ XXX Description of the change here
 The explanation of symbolic references being prevented by "strict refs"
 now doesn't assume that the reader knows what symbolic references are.
 
-=item *
-
-XXX Description of the change here
-
 =back
 
 =head3 L<perlfunc>
@@ -286,20 +195,6 @@ XXX Description of the change here
 
 The return value of C<pipe> is now documented.
 
-=item *
-
-XXX Description of the change here
-
-=back
-
-=head3 L<XXX>
-
-=over 4
-
-=item *
-
-XXX Description of the change here
-
 =back
 
 =head1 Diagnostics
@@ -308,31 +203,8 @@ 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.
-
-[ Within each section, list entries as a =item entry that links to perldiag,
-  e.g.
-
-  =item *
-
-  L<Invalid version object|perldiag/"Invalid version object">
-]
-
 =head2 New Diagnostics
 
-XXX Newly added diagnostic messages go here
-
-=head3 New Errors
-
-=over 4
-
-=item *
-
-XXX L<message|perldiag/"message">
-
-=back
-
 =head3 New Warnings
 
 =over 4
@@ -344,51 +216,9 @@ through|perldiag/"Unescaped left brace in regex is deprecated, passed
 through">" is a new deprecation warning.  See L</Unescaped braces in
 regexps>.
 
-=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 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
-
-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 ].
+=head1 Testing
 
 =over 4
 
@@ -399,43 +229,11 @@ of memory.  These tests won't run by default; they can be enabled by
 setting the C<PERL_TEST_MEMORY> environment variable to the number of
 gibibytes of memory that may be safely used.
 
-=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
-
-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.
+=head2 Platform-Specific Notes
 
 =over 4
 
@@ -455,47 +253,10 @@ guaranteed anyway in the situations where this would matter.)
 
 It should now be possible to compile Perl as C++ on VMS.
 
-=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 *
@@ -532,12 +293,6 @@ should be operationally invisible.
 
 =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 *
@@ -589,7 +344,7 @@ Now it produces an error.
 
 =item *
 
-C<vec> now works with extremely large offsets (>2 GB) [perl #111730].
+C<vec> now works with extremely large offsets (E<gt>2 GB) [perl #111730].
 
 =item *
 
@@ -659,35 +414,34 @@ briefly around fork to prevent this from happening [perl #82580].
 
 =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, unless
-they were specific to a particular platform (see below).
-
-This is a list of some significant unfixed bugs, which are regressions
-from either 5.XXX.XXX or 5.XXX.XXX.
-
-[ List each fix as a =item entry ]
-
-=over 4
-
-=item *
-
-XXX
+=head1 Acknowledgements
 
-=back
+Perl 5.17.0 represents approximately 1 week of development since Perl 5.16.0
+and contains approximately 17,000 lines of changes across 180 files from 26
+authors.
 
-=head1 Obituary
+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.16.1:
 
-XXX If any significant core contributor has died, we've added a short obituary
-here.
+Alan Haggai Alavi, Aristotle Pagaltzis, Brian Fraser, Chris 'BinGOs' Williams,
+Craig A. Berry, Dagfinn Ilmari Mannsåker, Eric Brine, Father Chrysostomos,
+Igor Zaytsev, James E Keenan, Karl Williamson, Leon Timmermans, Lukas Mai,
+Marcus Holland-Moritz, Matthew Horsfall, Moritz Lenz, Rafael Garcia-Suarez,
+Reini Urban, Ricardo Signes, Robin Barker, Ronald J. Kimball, Smylers, Steffen
+Müller, Steve Hay, Tony Cook, Zefram.
 
-=head1 Acknowledgements
+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.
 
-XXX Generate this with:
+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.
 
-  perl Porting/acknowledgements.pl v5.16.0..HEAD
+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