Make a new perldelta for 5.17.9-to-be
authorAaron Crane <arc@cpan.org>
Sun, 20 Jan 2013 19:14:59 +0000 (19:14 +0000)
committerAaron Crane <arc@cpan.org>
Sun, 20 Jan 2013 19:14:59 +0000 (19:14 +0000)
MANIFEST
Makefile.SH
pod/.gitignore
pod/perl.pod
pod/perl5178delta.pod [new file with mode: 0644]
pod/perldelta.pod
vms/descrip_mms.template
win32/Makefile
win32/makefile.mk
win32/pod.mak

index 31000e4..cc00d28 100644 (file)
--- a/MANIFEST
+++ b/MANIFEST
@@ -4692,6 +4692,7 @@ pod/perl5174delta.pod             Perl changes in version 5.17.4
 pod/perl5175delta.pod          Perl changes in version 5.17.5
 pod/perl5176delta.pod          Perl changes in version 5.17.6
 pod/perl5177delta.pod          Perl changes in version 5.17.7
+pod/perl5178delta.pod          Perl changes in version 5.17.8
 pod/perl561delta.pod           Perl changes in version 5.6.1
 pod/perl56delta.pod            Perl changes in version 5.6
 pod/perl581delta.pod           Perl changes in version 5.8.1
index 19eaeb1..31cacc8 100755 (executable)
@@ -491,7 +491,7 @@ mini_obj = $(minindt_obj) $(MINIDTRACE_O)
 ndt_obj = $(obj0) $(obj1) $(obj2) $(obj3) $(ARCHOBJS)
 obj = $(ndt_obj) $(DTRACE_O)
 
-perltoc_pod_prereqs = extra.pods pod/perl5178delta.pod pod/perlapi.pod pod/perlintern.pod pod/perlmodlib.pod pod/perluniprops.pod
+perltoc_pod_prereqs = extra.pods pod/perl5179delta.pod pod/perlapi.pod pod/perlintern.pod pod/perlmodlib.pod pod/perluniprops.pod
 generated_pods = pod/perltoc.pod $(perltoc_pod_prereqs)
 generated_headers = uudmap.h bitcount.h mg_data.h
 
@@ -1067,9 +1067,9 @@ pod/perlintern.pod: $(MINIPERL_EXE) autodoc.pl embed.fnc
 pod/perlmodlib.pod: $(MINIPERL_EXE) pod/perlmodlib.PL MANIFEST
        $(MINIPERL) $(Icwd) pod/perlmodlib.PL -q
 
-pod/perl5178delta.pod: pod/perldelta.pod
-       $(RMS) pod/perl5178delta.pod
-       $(LNS) perldelta.pod pod/perl5178delta.pod
+pod/perl5179delta.pod: pod/perldelta.pod
+       $(RMS) pod/perl5179delta.pod
+       $(LNS) perldelta.pod pod/perl5179delta.pod
 
 extra.pods: $(MINIPERL_EXE)
        -@test ! -f extra.pods || rm -f `cat extra.pods`
index 48e3628..17ebcb3 100644 (file)
@@ -59,7 +59,7 @@
 /roffitall
 
 # generated
-/perl5178delta.pod
+/perl5179delta.pod
 /perlapi.pod
 /perlintern.pod
 *.html
index eba3cc7..0747b35 100644 (file)
@@ -179,6 +179,7 @@ aux a2p c2ph h2ph h2xs perlbug pl2pm pod2html pod2man s2p splain xsubpp
 
     perlhist           Perl history records
     perldelta          Perl changes since previous version
+    perl5178delta      Perl changes in version 5.17.8
     perl5177delta      Perl changes in version 5.17.7
     perl5176delta      Perl changes in version 5.17.6
     perl5175delta      Perl changes in version 5.17.5
diff --git a/pod/perl5178delta.pod b/pod/perl5178delta.pod
new file mode 100644 (file)
index 0000000..41821fc
--- /dev/null
@@ -0,0 +1,341 @@
+=encoding utf8
+
+=head1 NAME
+
+perl5178delta - what is new for perl v5.17.8
+
+=head1 DESCRIPTION
+
+This document describes differences between the 5.17.7 release and the 5.17.8
+release.
+
+If you are upgrading from an earlier release such as 5.17.6, first read
+L<perl5177delta>, which describes differences between 5.17.6 and 5.17.7.
+
+=head1 Core Enhancements
+
+=head2 Regular Expression Set Operations
+
+This is an experimental feature to allow matching against the the union,
+intersection, etc., of sets of code points, similar to
+L<Unicode::Regex::Set>.  It can also be used to extend C</x> processing
+to [bracketed] character classes, and as a replacement of user-defined
+properties, allowing more complex expressions than they do.  See
+L<perlre/(?[ ])>.
+
+=head1 Deprecations
+
+=head2 Deprecated modules
+
+The Pod::LaTeX module is now deprecated, and due to be moved out of the Perl
+core in 5.20.  Until then, using the core-installed version will produce a
+warning.  You can suppress the warning by installing the module from CPAN.
+
+=head2 User-defined charnames with surprising whitespace
+
+A user-defined character name with trailing or multiple spaces in a row is
+likely a typo.  This now generates a warning when defined, on the assumption
+that uses of it will be unlikely to include the excess whitespace.
+
+=head2 Various XS-callable functions are now deprecated
+
+All the functions used to classify characters will be removed from a
+future version of Perl, and should not be used.  With participating C
+compilers (e.g., gcc), compiling any file that uses any of these will
+generate a warning.  These were not intended for public use; there are
+equivalent, faster, macros for most of them.
+See L<perlapi/Character classes>.  The complete list (including some
+that were deprecated in 5.17.7) is:
+C<is_uni_alnum>, C<is_uni_alnumc>, C<is_uni_alnumc_lc>,
+C<is_uni_alnum_lc>, C<is_uni_alpha>, C<is_uni_alpha_lc>,
+C<is_uni_ascii>, C<is_uni_ascii_lc>, C<is_uni_blank>,
+C<is_uni_blank_lc>, C<is_uni_cntrl>, C<is_uni_cntrl_lc>,
+C<is_uni_digit>, C<is_uni_digit_lc>, C<is_uni_graph>,
+C<is_uni_graph_lc>, C<is_uni_idfirst>, C<is_uni_idfirst_lc>,
+C<is_uni_lower>, C<is_uni_lower_lc>, C<is_uni_print>,
+C<is_uni_print_lc>, C<is_uni_punct>, C<is_uni_punct_lc>,
+C<is_uni_space>, C<is_uni_space_lc>, C<is_uni_upper>,
+C<is_uni_upper_lc>, C<is_uni_xdigit>, C<is_uni_xdigit_lc>,
+C<is_utf8_alnum>, C<is_utf8_alnumc>, C<is_utf8_alpha>,
+C<is_utf8_ascii>, C<is_utf8_blank>, C<is_utf8_char>,
+C<is_utf8_cntrl>, C<is_utf8_digit>, C<is_utf8_graph>,
+C<is_utf8_idcont>, C<is_utf8_idfirst>, C<is_utf8_lower>,
+C<is_utf8_mark>, C<is_utf8_perl_space>, C<is_utf8_perl_word>,
+C<is_utf8_posix_digit>, C<is_utf8_print>, C<is_utf8_punct>,
+C<is_utf8_space>, C<is_utf8_upper>, C<is_utf8_xdigit>,
+C<is_utf8_xidcont>, C<is_utf8_xidfirst>.
+
+In addition these three functions that have never worked properly are
+deprecated:
+C<to_uni_lower_lc>, C<to_uni_title_lc>, and C<to_uni_upper_lc>.
+
+=head2 Certain rare uses of backslashes within regexes are now deprectated
+
+There are three pairs of characters that Perl recognizes as
+metacharacters in regular expression patterns: C<{}>, C<[]>, and C<()>.
+These can be used as well to delimit patterns, as in:
+
+ m{foo}
+ s(foo)(bar)
+
+Since they are metacharacters, they have special meaning to regular
+expression patterns, and it turns out that you can't turn off that
+special meaning by the normal means of preceding them with a backslash,
+if you use them, paired, within a pattern delimitted by them.  For
+example, in
+
+ m{foo\{1,3\}}
+
+the backslashes do not change the behavior, and this matches
+S<C<"f o">> followed by one to three more occurrences of C<"o">.
+
+Usages like this, where they are interpreted as metacharacters, are
+exceedingly rare; we think there are none, for example, in all of CPAN.
+Hence, this deprecation should affect very little code.  It does give
+notice, however, that any such code needs to change, which will in turn
+allow us to change the behavior in future Perl versions so that the
+backslashes do have an effect, and without fear that we are silently
+breaking any existing code.
+
+=head1 Modules and Pragmata
+
+=head2 Selected Updates to Modules and Pragmata
+
+=over 4
+
+=item *
+
+Several modules have had their version number changed to one with no
+underscore, since such version numbers are usually interpreted to mean
+"development-only version".  No other changes have been made in these cases.
+The affected modules are:
+
+=over 4
+
+=item *
+
+L<I18N::Langinfo> was 0.08_02 and is now 0.09
+
+=item *
+
+L<I18N::LangTags::List> was 0.35_01 and is now 0.39
+
+=item *
+
+L<IO> was 1.25_08 and is now 1.26
+
+=item *
+
+L<Safe> was 2.33_01 and is now 2.34
+
+=item *
+
+L<Test> was 1.25_02 and is now 1.26.
+
+=back
+
+=item *
+
+L<Digest::SHA> has been upgraded from version 5.80 to 5.81.  This fixes a
+double-free bug, which might have caused vulnerabilities in some cases.
+
+=item *
+
+L<Module::CoreList> has been upgraded from 2.79 to 2.80.
+
+=item *
+
+L<Socket> has been upgraded from 2.006_001 to 2.009.  This fixes an
+uninitialized memory read.
+
+=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>.
+
+=head2 New Diagnostics
+
+=head3 New Warnings
+
+=over 4
+
+=item *
+
+L<'%s' resolved to '\o{%s}%d'|perldiag/"'%s' resolved to '\o{%s}%d'">
+
+=item *
+
+L<'Trailing white-space in a charnames alias definition is deprecated'|perldiag/"Trailing white-space in a charnames alias definition is deprecated">
+
+=item *
+
+L<'A sequence of multiple spaces in a charnames alias definition is deprecated'|perldiag/"A sequence of multiple spaces in a charnames alias definition is deprecated">
+
+=item *
+
+L<'Passing malformed UTF-8 to "%s" is deprecated'|perldiag/"Passing malformed UTF-8 to "%s" is deprecated">
+
+=back
+
+=head1 Testing
+
+=over 4
+
+=item *
+
+Many more of the core's tests now have descriptions.
+
+=item *
+
+Thread stress-tests now adapt to the speed of the machine running the tests,
+thus reducing the incidence of false failures.
+
+=back
+
+=head1 Platform Support
+
+=head2 Discontinued Platforms
+
+=over 4
+
+=item Rhapsody
+
+Support for Rhapsody has been removed.
+
+=back
+
+=head2 Platform-Specific Notes
+
+=over 4
+
+=item Windows
+
+Perl can now be built using Microsoft's Visual C++ 2012 compiler by specifying
+CCTYPE=MSVC110 (or MSVC110FREE if you are using the free Express edition for
+Windows Desktop) in F<win32/Makefile>.
+
+=item Haiku
+
+Perl should now work out of the box on Haiku R1 Alpha 4.
+
+=back
+
+=head1 Internal Changes
+
+=over 4
+
+=item *
+
+A synonym for the misleadingly named C<av_len()> has been created:
+C<av_top()>.  Both of these return the number of the highest index in
+the array, not the number of elements it contains.
+
+=back
+
+=head1 Selected Bug Fixes
+
+=over 4
+
+=item *
+
+A bug in the core typemap caused any C types that map to the T_BOOL core
+typemap entry to not be set, updated, or modified when the T_BOOL variable was
+used in an OUTPUT: section with an exception for RETVAL. T_BOOL in an INPUT:
+section was not affected. Using a T_BOOL return type for an XSUB (RETVAL)
+was not affected. A side effect of fixing this bug is, if a T_BOOL is specified
+in the OUTPUT: section (which previous did nothing to the SV), and a read only
+SV (literal) is passed to the XSUB, croaks like "Modification of a read-only
+value attempted" will happen. [perl #115796]
+
+=item *
+
+On many platforms, providing a directory name as the script name caused perl
+to do nothing and report success.  It should now universally report an error
+and exit nonzero. [perl #61362]
+
+=back
+
+=head1 Known Problems
+
+=over 4
+
+=item *
+
+Perl 5.17.7 introduced a new internal copy-on-write mechanism, in the
+interests of speed.  An flaw in the implementation means that some regexp
+matches which previously completed very fast, without invoking the full
+regexp engine, now run much slower than before.  We expect this performance
+problem to be resolved before 5.18.0 is released.
+
+=item *
+
+The C<POSIX> module may yield test failures when building on a ZFS
+filesystem under FreeBSD.
+
+=back
+
+=head1 Acknowledgements
+
+Perl 5.17.8 represents approximately 5 weeks of development since Perl 5.17.7
+and contains approximately 18,000 lines of changes across 280 files from 24
+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.17.8:
+
+Aaron Crane, Andy Dougherty, Augustina Blair, Chris 'BinGOs' Williams, Craig
+A. Berry, Daniel Dragan, Dave Rolsky, David Mitchell, Eric Brine, Father
+Chrysostomos, H.Merijn Brand, James E Keenan, Jerry D. Hedden, Jesse Luehrs,
+Karl Williamson, Matthew Horsfall, Nicholas Clark, Renee Baecker, Ricardo
+Signes, Shlomi Fish, Steffen Müller, Steve Hay, Steven Schubiger, Tony Cook.
+
+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.
+
+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.
+
+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 will 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 f99ccb7..cf512ad 100644 (file)
 
 =head1 NAME
 
-perldelta - what is new for perl v5.17.8
+[ 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.9
 
 =head1 DESCRIPTION
 
-This document describes differences between the 5.17.7 release and the 5.17.8
+This document describes differences between the 5.17.8 release and the 5.17.9
 release.
 
-If you are upgrading from an earlier release such as 5.17.6, first read
-L<perl5177delta>, which describes differences between 5.17.6 and 5.17.7.
+If you are upgrading from an earlier release such as 5.17.7, first read
+L<perl5178delta>, which describes differences between 5.17.7 and 5.17.8.
+
+=head1 Notice
+
+XXX Any important notices here
 
 =head1 Core Enhancements
 
-=head2 Regular Expression Set Operations
+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
+
+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 ]
 
-This is an experimental feature to allow matching against the the union,
-intersection, etc., of sets of code points, similar to
-L<Unicode::Regex::Set>.  It can also be used to extend C</x> processing
-to [bracketed] character classes, and as a replacement of user-defined
-properties, allowing more complex expressions than they do.  See
-L<perlre/(?[ ])>.
+=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 ]
 
 =head1 Deprecations
 
-=head2 Deprecated modules
-
-The Pod::LaTeX module is now deprecated, and due to be moved out of the Perl
-core in 5.20.  Until then, using the core-installed version will produce a
-warning.  You can suppress the warning by installing the module from CPAN.
-
-=head2 User-defined charnames with surprising whitespace
-
-A user-defined character name with trailing or multiple spaces in a row is
-likely a typo.  This now generates a warning when defined, on the assumption
-that uses of it will be unlikely to include the excess whitespace.
-
-=head2 Various XS-callable functions are now deprecated
-
-All the functions used to classify characters will be removed from a
-future version of Perl, and should not be used.  With participating C
-compilers (e.g., gcc), compiling any file that uses any of these will
-generate a warning.  These were not intended for public use; there are
-equivalent, faster, macros for most of them.
-See L<perlapi/Character classes>.  The complete list (including some
-that were deprecated in 5.17.7) is:
-C<is_uni_alnum>, C<is_uni_alnumc>, C<is_uni_alnumc_lc>,
-C<is_uni_alnum_lc>, C<is_uni_alpha>, C<is_uni_alpha_lc>,
-C<is_uni_ascii>, C<is_uni_ascii_lc>, C<is_uni_blank>,
-C<is_uni_blank_lc>, C<is_uni_cntrl>, C<is_uni_cntrl_lc>,
-C<is_uni_digit>, C<is_uni_digit_lc>, C<is_uni_graph>,
-C<is_uni_graph_lc>, C<is_uni_idfirst>, C<is_uni_idfirst_lc>,
-C<is_uni_lower>, C<is_uni_lower_lc>, C<is_uni_print>,
-C<is_uni_print_lc>, C<is_uni_punct>, C<is_uni_punct_lc>,
-C<is_uni_space>, C<is_uni_space_lc>, C<is_uni_upper>,
-C<is_uni_upper_lc>, C<is_uni_xdigit>, C<is_uni_xdigit_lc>,
-C<is_utf8_alnum>, C<is_utf8_alnumc>, C<is_utf8_alpha>,
-C<is_utf8_ascii>, C<is_utf8_blank>, C<is_utf8_char>,
-C<is_utf8_cntrl>, C<is_utf8_digit>, C<is_utf8_graph>,
-C<is_utf8_idcont>, C<is_utf8_idfirst>, C<is_utf8_lower>,
-C<is_utf8_mark>, C<is_utf8_perl_space>, C<is_utf8_perl_word>,
-C<is_utf8_posix_digit>, C<is_utf8_print>, C<is_utf8_punct>,
-C<is_utf8_space>, C<is_utf8_upper>, C<is_utf8_xdigit>,
-C<is_utf8_xidcont>, C<is_utf8_xidfirst>.
-
-In addition these three functions that have never worked properly are
-deprecated:
-C<to_uni_lower_lc>, C<to_uni_title_lc>, and C<to_uni_upper_lc>.
-
-=head2 Certain rare uses of backslashes within regexes are now deprectated
-
-There are three pairs of characters that Perl recognizes as
-metacharacters in regular expression patterns: C<{}>, C<[]>, and C<()>.
-These can be used as well to delimit patterns, as in:
-
- m{foo}
- s(foo)(bar)
-
-Since they are metacharacters, they have special meaning to regular
-expression patterns, and it turns out that you can't turn off that
-special meaning by the normal means of preceding them with a backslash,
-if you use them, paired, within a pattern delimitted by them.  For
-example, in
-
- m{foo\{1,3\}}
-
-the backslashes do not change the behavior, and this matches
-S<C<"f o">> followed by one to three more occurrences of C<"o">.
-
-Usages like this, where they are interpreted as metacharacters, are
-exceedingly rare; we think there are none, for example, in all of CPAN.
-Hence, this deprecation should affect very little code.  It does give
-notice, however, that any such code needs to change, which will in turn
-allow us to change the behavior in future Perl versions so that the
-backslashes do have an effect, and without fear that we are silently
-breaking any existing code.
+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.
 
-=head1 Modules and Pragmata
+[ List each 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.
 
-=head2 Selected Updates to Modules and Pragmata
+[ List each enhancement as a =item entry ]
 
 =over 4
 
 =item *
 
-Several modules have had their version number changed to one with no
-underscore, since such version numbers are usually interpreted to mean
-"development-only version".  No other changes have been made in these cases.
-The affected modules are:
+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 *
 
-L<I18N::Langinfo> was 0.08_02 and is now 0.09
+XXX
 
-=item *
+=back
 
-L<I18N::LangTags::List> was 0.35_01 and is now 0.39
+=head2 Updated Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<IO> was 1.25_08 and is now 1.26
+L<XXX> has been upgraded from version A.xx to B.yy.
 
-=item *
+=back
+
+=head2 Removed Modules and Pragmata
 
-L<Safe> was 2.33_01 and is now 2.34
+=over 4
 
 =item *
 
-L<Test> was 1.25_02 and is now 1.26.
+XXX
 
 =back
 
-=item *
+=head1 Documentation
 
-L<Digest::SHA> has been upgraded from version 5.80 to 5.81.  This fixes a
-double-free bug, which might have caused vulnerabilities in some cases.
+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 *
+=head2 New Documentation
+
+XXX Changes which create B<new> files in F<pod/> go here.
 
-L<Module::CoreList> has been upgraded from 2.79 to 2.80.
+=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 *
 
-L<Socket> has been upgraded from 2.006_001 to 2.009.  This fixes an
-uninitialized memory read.
+XXX Description of the change here
 
 =back
 
@@ -156,154 +145,206 @@ 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
 
-=head3 New Warnings
+XXX Newly added diagnostic messages go under here, separated into New Errors
+and New Warnings
+
+=head3 New Errors
 
 =over 4
 
 =item *
 
-L<'%s' resolved to '\o{%s}%d'|perldiag/"'%s' resolved to '\o{%s}%d'">
+XXX L<message|perldiag/"message">
+
+=back
+
+=head3 New Warnings
+
+=over 4
 
 =item *
 
-L<'Trailing white-space in a charnames alias definition is deprecated'|perldiag/"Trailing white-space in a charnames alias definition is deprecated">
+XXX L<message|perldiag/"message">
+
+=back
+
+=head2 Changes to Existing Diagnostics
+
+XXX Changes (i.e. rewording) of diagnostic messages go here
+
+=over 4
 
 =item *
 
-L<'A sequence of multiple spaces in a charnames alias definition is deprecated'|perldiag/"A sequence of multiple spaces in a charnames alias definition is deprecated">
+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 *
 
-L<'Passing malformed UTF-8 to "%s" is deprecated'|perldiag/"Passing malformed UTF-8 to "%s" is deprecated">
+XXX
 
 =back
 
-=head1 Testing
+=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 *
 
-Many more of the core's tests now have descriptions.
+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 *
 
-Thread stress-tests now adapt to the speed of the machine running the tests,
-thus reducing the incidence of false failures.
+XXX
 
 =back
 
 =head1 Platform Support
 
-=head2 Discontinued Platforms
+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 Rhapsody
+=item XXX-some-platform
 
-Support for Rhapsody has been removed.
+XXX
 
 =back
 
-=head2 Platform-Specific Notes
+=head2 Discontinued Platforms
+
+XXX List any platforms that this version of perl no longer compiles on.
 
 =over 4
 
-=item Windows
+=item XXX-some-platform
+
+XXX
 
-Perl can now be built using Microsoft's Visual C++ 2012 compiler by specifying
-CCTYPE=MSVC110 (or MSVC110FREE if you are using the free Express edition for
-Windows Desktop) in F<win32/Makefile>.
+=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 Haiku
+=item XXX-some-platform
 
-Perl should now work out of the box on Haiku R1 Alpha 4.
+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 *
 
-A synonym for the misleadingly named C<av_len()> has been created:
-C<av_top()>.  Both of these return the number of the highest index in
-the array, not the number of elements it contains.
+XXX
 
 =back
 
 =head1 Selected Bug Fixes
 
-=over 4
+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>.
 
-=item *
+[ List each fix as a =item entry ]
 
-A bug in the core typemap caused any C types that map to the T_BOOL core
-typemap entry to not be set, updated, or modified when the T_BOOL variable was
-used in an OUTPUT: section with an exception for RETVAL. T_BOOL in an INPUT:
-section was not affected. Using a T_BOOL return type for an XSUB (RETVAL)
-was not affected. A side effect of fixing this bug is, if a T_BOOL is specified
-in the OUTPUT: section (which previous did nothing to the SV), and a read only
-SV (literal) is passed to the XSUB, croaks like "Modification of a read-only
-value attempted" will happen. [perl #115796]
+=over 4
 
 =item *
 
-On many platforms, providing a directory name as the script name caused perl
-to do nothing and report success.  It should now universally report an error
-and exit nonzero. [perl #61362]
+XXX
 
 =back
 
 =head1 Known Problems
 
-=over 4
+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.
 
-=item *
+[ List each fix as a =item entry ]
 
-Perl 5.17.7 introduced a new internal copy-on-write mechanism, in the
-interests of speed.  An flaw in the implementation means that some regexp
-matches which previously completed very fast, without invoking the full
-regexp engine, now run much slower than before.  We expect this performance
-problem to be resolved before 5.18.0 is released.
+=over 4
 
 =item *
 
-The C<POSIX> module may yield test failures when building on a ZFS
-filesystem under FreeBSD.
+XXX
 
 =back
 
-=head1 Acknowledgements
-
-Perl 5.17.8 represents approximately 5 weeks of development since Perl 5.17.7
-and contains approximately 18,000 lines of changes across 280 files from 24
-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.17.8:
+=head1 Obituary
 
-Aaron Crane, Andy Dougherty, Augustina Blair, Chris 'BinGOs' Williams, Craig
-A. Berry, Daniel Dragan, Dave Rolsky, David Mitchell, Eric Brine, Father
-Chrysostomos, H.Merijn Brand, James E Keenan, Jerry D. Hedden, Jesse Luehrs,
-Karl Williamson, Matthew Horsfall, Nicholas Clark, Renee Baecker, Ricardo
-Signes, Shlomi Fish, Steffen Müller, Steve Hay, Steven Schubiger, Tony Cook.
+XXX If any significant core contributor has died, we've added a short obituary
+here.
 
-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.
+=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.17.8..HEAD
 
 =head1 Reporting Bugs
 
index 4c61a01..1ecd3be 100644 (file)
@@ -326,7 +326,7 @@ x2p : [.x2p]$(DBG)a2p$(E) [.x2p]s2p.com [.x2p]find2perl.com
 extra.pods : miniperl
        @ @extra_pods.com
 
-PERLDELTA_CURRENT = [.pod]perl5178delta.pod
+PERLDELTA_CURRENT = [.pod]perl5179delta.pod
 
 $(PERLDELTA_CURRENT) : [.pod]perldelta.pod
        Copy/NoConfirm/Log $(MMS$SOURCE) $(PERLDELTA_CURRENT)
index b2bae9f..416b6ab 100644 (file)
@@ -1157,7 +1157,7 @@ utils: $(PERLEXE) $(X2P)
        copy ..\README.tw       ..\pod\perltw.pod
        copy ..\README.vos      ..\pod\perlvos.pod
        copy ..\README.win32    ..\pod\perlwin32.pod
-       copy ..\pod\perldelta.pod ..\pod\perl5178delta.pod
+       copy ..\pod\perldelta.pod ..\pod\perl5179delta.pod
        cd ..\win32
        $(PERLEXE) $(PL2BAT) $(UTILS)
        $(PERLEXE) $(ICWD) ..\autodoc.pl ..
@@ -1250,7 +1250,7 @@ distclean: realclean
        -if exist $(LIBDIR)\XS rmdir /s /q $(LIBDIR)\XS
        -if exist $(LIBDIR)\Win32API rmdir /s /q $(LIBDIR)\Win32API
        -cd $(PODDIR) && del /f *.html *.bat roffitall \
-           perl5178delta.pod perlaix.pod perlamiga.pod perlapi.pod \
+           perl5179delta.pod perlaix.pod perlamiga.pod perlapi.pod \
            perlbs2000.pod perlce.pod perlcn.pod perlcygwin.pod \
            perldgux.pod perldos.pod perlfreebsd.pod perlhaiku.pod \
            perlhpux.pod perlhurd.pod perlintern.pod perlirix.pod \
index 4ea84b9..7281a43 100644 (file)
@@ -1337,7 +1337,7 @@ utils: $(PERLEXE) $(X2P)
        copy ..\README.tw       ..\pod\perltw.pod
        copy ..\README.vos      ..\pod\perlvos.pod
        copy ..\README.win32    ..\pod\perlwin32.pod
-       copy ..\pod\perldelta.pod ..\pod\perl5178delta.pod
+       copy ..\pod\perldelta.pod ..\pod\perl5179delta.pod
        $(PERLEXE) $(PL2BAT) $(UTILS)
        $(PERLEXE) $(ICWD) ..\autodoc.pl ..
        $(PERLEXE) $(ICWD) ..\pod\perlmodlib.pl -q
@@ -1429,7 +1429,7 @@ distclean: realclean
        -if exist $(LIBDIR)\XS rmdir /s /q $(LIBDIR)\XS
        -if exist $(LIBDIR)\Win32API rmdir /s /q $(LIBDIR)\Win32API
        -cd $(PODDIR) && del /f *.html *.bat roffitall \
-           perl5178delta.pod perlaix.pod perlamiga.pod perlapi.pod \
+           perl5179delta.pod perlaix.pod perlamiga.pod perlapi.pod \
            perlbs2000.pod perlce.pod perlcn.pod perlcygwin.pod \
            perldgux.pod perldos.pod perlfreebsd.pod perlhaiku.pod \
            perlhpux.pod perlhurd.pod perlintern.pod perlirix.pod \
index 8625bb7..5b6b9ac 100644 (file)
@@ -40,6 +40,7 @@ POD = perl.pod        \
        perl5176delta.pod       \
        perl5177delta.pod       \
        perl5178delta.pod       \
+       perl5179delta.pod       \
        perl561delta.pod        \
        perl56delta.pod \
        perl581delta.pod        \
@@ -171,6 +172,7 @@ MAN = perl.man      \
        perl5176delta.man       \
        perl5177delta.man       \
        perl5178delta.man       \
+       perl5179delta.man       \
        perl561delta.man        \
        perl56delta.man \
        perl581delta.man        \
@@ -302,6 +304,7 @@ HTML = perl.html    \
        perl5176delta.html      \
        perl5177delta.html      \
        perl5178delta.html      \
+       perl5179delta.html      \
        perl561delta.html       \
        perl56delta.html        \
        perl581delta.html       \
@@ -433,6 +436,7 @@ TEX = perl.tex      \
        perl5176delta.tex       \
        perl5177delta.tex       \
        perl5178delta.tex       \
+       perl5179delta.tex       \
        perl561delta.tex        \
        perl56delta.tex \
        perl581delta.tex        \