summaryrefslogtreecommitdiff
path: root/pod/perldelta.pod
diff options
context:
space:
mode:
Diffstat (limited to 'pod/perldelta.pod')
-rw-r--r--pod/perldelta.pod376
1 files changed, 240 insertions, 136 deletions
diff --git a/pod/perldelta.pod b/pod/perldelta.pod
index 3aa81ec2db..b96db871da 100644
--- a/pod/perldelta.pod
+++ b/pod/perldelta.pod
@@ -2,279 +2,383 @@
=head1 NAME
-perldelta - what is new for perl v5.20.3
+[ 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.20.4
=head1 DESCRIPTION
-This document describes differences between the 5.20.2 release and the 5.20.3
+This document describes differences between the 5.20.3 release and the 5.20.4
release.
-If you are upgrading from an earlier release such as 5.20.1, first read
-L<perl5202delta>, which describes differences between 5.20.1 and 5.20.2.
+If you are upgrading from an earlier release such as 5.20.2, first read
+L<perl5203delta>, which describes differences between 5.20.2 and 5.20.3.
+
+=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
+
+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
-There are no changes intentionally incompatible with 5.20.2. If any exist,
-they are bugs, and we request that you submit a report. See L</Reporting Bugs>
-below.
+XXX For a release on a stable branch, this section aspires to be:
-=head1 Modules and Pragmata
+ 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.
-=head2 Updated Modules and Pragmata
+[ 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</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 *
-L<Errno> has been upgraded from version 1.20_05 to 1.20_06.
+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.
-Add B<-P> to the pre-processor command-line on GCC 5. GCC added extra line
-directives, breaking parsing of error code definitions.
-L<[perl #123784]|https://rt.perl.org/Ticket/Display.html?id=123784>
+[ Within each section, list entries as a =item entry ]
+
+=head2 New Modules and Pragmata
+
+=over 4
=item *
-L<Module::CoreList> has been upgraded from version 5.20150214 to 5.20150822.
+XXX
-Updated to cover the latest releases of Perl.
+=back
+
+=head2 Updated Modules and Pragmata
+
+=over 4
=item *
-L<perl5db.pl> has been upgraded from 1.44 to 1.44_01.
+L<XXX> has been upgraded from version A.xx to B.yy.
+
+=back
+
+=head2 Removed Modules and Pragmata
+
+=over 4
-The debugger would cause an assertion failure.
-L<[perl #124127]|https://rt.perl.org/Ticket/Display.html?id=124127>
+=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
-=head3 L<perlfunc>
+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 *
-Mention that L<C<study()>|perlfunc/study> is currently a no-op.
+XXX Description of the change here
=back
-=head3 L<perlguts>
+=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 *
-The OOK example has been updated to account for COW changes and a change in the
-storage of the offset.
+XXX L<message|perldiag/"message">
=back
-=head3 L<perlhacktips>
+=head3 New Warnings
=over 4
=item *
-Documentation has been added illustrating the perils of assuming the contents
-of static memory pointed to by the return values of Perl wrappers for C library
-functions doesn't change.
+XXX L<message|perldiag/"message">
=back
-=head3 L<perlpodspec>
+=head2 Changes to Existing Diagnostics
+
+XXX Changes (i.e. rewording) of diagnostic messages go here
=over 4
=item *
-The specification of the POD language is changing so that the default encoding
-of PODs that aren't in UTF-8 (unless otherwise indicated) is CP1252 instead of
-ISO-8859-1 (Latin1).
+XXX Describe change here
=back
=head1 Utility Changes
-=head2 L<h2ph>
+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 =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 *
-B<h2ph> now handles hexadecimal constants in the compiler's predefined macro
-definitions, as visible in C<$Config{cppsymbols}>.
-L<[perl #123784]|https://rt.perl.org/Ticket/Display.html?id=123784>
+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 *
-F<t/perf/taint.t> has been added to see if optimisations with taint issues are
-keeping things fast.
+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 *
-F<t/porting/re_context.t> has been added to test that L<utf8> and its
-dependencies only use the subset of the C<$1..$n> capture vars that
-Perl_save_re_context() is hard-coded to localize, because that function has no
-efficient way of determining at runtime what vars to localize.
+XXX
=back
=head1 Platform Support
-=head2 Platform-Specific Notes
+XXX Any changes to platform support should be listed in the sections below.
-=over 4
+[ Within the sections, list each platform as a =item entry with specific
+changes as paragraphs below it. ]
-=item Win32
+=head2 New Platforms
-=over 4
-
-=item *
+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.
-Previously, when compiling with a 64-bit Visual C++, every Perl XS module
-(including CPAN ones) and Perl aware C file would unconditionally have around a
-dozen warnings from F<hv_func.h>. These warnings have been silenced. GCC (all
-bitness) and 32-bit Visual C++ were not affected.
+=over 4
-=item *
+=item XXX-some-platform
-B<miniperl.exe> is now built with B<-fno-strict-aliasing>, allowing 64-bit
-builds to complete with GCC 4.8.
-L<[perl #123976]|https://rt.perl.org/Ticket/Display.html?id=123976>
+XXX
=back
-=back
+=head2 Discontinued Platforms
-=head1 Selected Bug Fixes
+XXX List any platforms that this version of perl no longer compiles on.
=over 4
-=item *
+=item XXX-some-platform
-Repeated global pattern matches in scalar context on large tainted strings were
-exponentially slow depending on the current match position in the string.
-L<[perl #123202]|https://rt.perl.org/Ticket/Display.html?id=123202>
+XXX
-=item *
+=back
-The original visible value of L<C<$E<sol>>|perlvar/$E<sol>> is now preserved
-when it is set to an invalid value. Previously if you set C<$/> to a reference
-to an array, for example, perl would produce a runtime error and not set PL_rs,
-but Perl code that checked C<$/> would see the array reference.
-L<[perl #123218]|https://rt.perl.org/Ticket/Display.html?id=123218>
+=head2 Platform-Specific Notes
-=item *
+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.
-Perl 5.14.0 introduced a bug whereby C<eval { LABEL: }> would crash. This has
-been fixed.
-L<[perl #123652]|https://rt.perl.org/Ticket/Display.html?id=123652>
+=over 4
-=item *
+=item XXX-some-platform
-Extending an array cloned from a parent thread could result in "Modification of
-a read-only value attempted" errors when attempting to modify the new elements.
-L<[perl #124127]|https://rt.perl.org/Ticket/Display.html?id=124127>
+XXX
-=item *
+=back
-Several cases of data used to store environment variable contents in core C
-code being potentially overwritten before being used have been fixed.
-L<[perl #123748]|https://rt.perl.org/Ticket/Display.html?id=123748>
+=head1 Internal Changes
-=item *
+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.
-UTF-8 variable names used in array indexes, unquoted UTF-8 HERE-document
-terminators and UTF-8 function names all now work correctly.
-L<[perl #124113]|https://rt.perl.org/Ticket/Display.html?id=124113>
+[ List each change as a =item entry ]
+
+=over 4
=item *
-A subtle bug introduced in Perl 5.20.2 involving UTF-8 in regular expressions
-and sometimes causing a crash has been fixed. A new test script has been added
-to test this fix; see under L</Testing>.
-L<[perl #124109]|https://rt.perl.org/Ticket/Display.html?id=124109>
+XXX
-=item *
+=back
-Some patterns starting with C</.*..../> matched against long strings have been
-slow since Perl 5.8, and some of the form C</.*..../i> have been slow since
-Perl 5.18. They are now all fast again.
-L<[perl #123743]|https://rt.perl.org/Ticket/Display.html?id=123743>
+=head1 Selected Bug Fixes
-=item *
+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>.
-Warning fatality is now ignored when rewinding the stack. This prevents
-infinite recursion when the now fatal error also causes rewinding of the stack.
-L<[perl #123398]|https://rt.perl.org/Ticket/Display.html?id=123398>
+[ List each fix as a =item entry ]
+
+=over 4
=item *
-C<setpgrp($nonzero)> (with one argument) was accidentally changed in Perl 5.16
-to mean C<setpgrp(0)>. This has been fixed.
+XXX
-=item *
+=back
-A crash with C<< %::=(); J->${\"::"} >> has been fixed.
-L<[perl #125541]|https://rt.perl.org/Ticket/Display.html?id=125541>
+=head1 Known Problems
-=item *
+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.
-Regular expression possessive quantifier Perl 5.20 regression now fixed.
-C<qr/>I<PAT>C<{>I<min>,I<max>C<}+>C</> is supposed to behave identically to
-C<qr/(?E<gt>>I<PAT>C<{>I<min>,I<max>C<})/>. Since Perl 5.20, this didn't work
-if I<min> and I<max> were equal.
-L<[perl #125825]|https://rt.perl.org/Ticket/Display.html?id=125825>
+[ List each fix as a =item entry ]
+
+=over 4
=item *
-Code like C</$a[/> used to read the next line of input and treat it as though
-it came immediately after the opening bracket. Some invalid code consequently
-would parse and run, but some code caused crashes, so this is now disallowed.
-L<[perl #123712]|https://rt.perl.org/Ticket/Display.html?id=123712>
+XXX
=back
-=head1 Acknowledgements
+=head1 Errata From Previous Releases
-Perl 5.20.3 represents approximately 7 months of development since Perl 5.20.2
-and contains approximately 3,200 lines of changes across 99 files from 26
-authors.
+=over 4
+
+=item *
-Excluding auto-generated files, documentation and release tools, there were
-approximately 1,500 lines of changes to 43 .pm, .t, .c and .h files.
+XXX Add anything here that we forgot to add, or were mistaken about, in
+the perldelta of a previous release.
-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.20.3:
+=back
+
+=head1 Obituary
-Alex Vandiver, Andy Dougherty, Aristotle Pagaltzis, Chris 'BinGOs' Williams,
-Craig A. Berry, Dagfinn Ilmari Mannsåker, Daniel Dragan, David Mitchell,
-Father Chrysostomos, H.Merijn Brand, James E Keenan, James McCoy, Jarkko
-Hietaniemi, Karen Etheridge, Karl Williamson, kmx, Lajos Veres, Lukas Mai,
-Matthew Horsfall, Petr Písař, Randy Stauner, Ricardo Signes, Sawyer X, Steve
-Hay, Tony Cook, Yves Orton.
+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.20.3..HEAD
=head1 Reporting Bugs