This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
for storage of NVs, use "IV in sv_u in head no-body trick" where possible
[perl5.git] / pod / perldelta.pod
index 6b9a4d5..a420c09 100644 (file)
 
 =head1 NAME
 
-perldelta - what is new for perl v5.21.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.21.5
 
 =head1 DESCRIPTION
 
-This document describes differences between the 5.21.2 release and the 5.21.3
+This document describes differences between the 5.21.4 release and the 5.21.5
 release.
 
-If you are upgrading from an earlier release such as 5.21.1, first read
-L<perl5212delta>, which describes differences between 5.21.1 and 5.21.2.
+If you are upgrading from an earlier release such as 5.21.3, first read
+L<perl5214delta>, which describes differences between 5.21.3 and 5.21.4.
 
-=head1 Core Enhancements
+=head1 Notice
+
+XXX Any important notices here
 
-=head2 C<defined(@array = LIST)> is no longer fatal
+=head1 Core Enhancements
 
-In 5.21.1, C<defined(@array)> was made fatal.  This has been relaxed
-to not die if the argument is assigning to an array.
+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.
 
-=head2 Floating point handling and parsing has been improved
+[ List each enhancement as a =head2 entry ]
 
-Parsing and printing of floating point values has been improved.
-XXX what in addition to hexadecimal floats? if nothing, change the head2.
+=head2 Perl now supports POSIX 2008 locale currency additions.
 
-As a completely new feature, hexadecimal floating point literals
-(like 0x1.23p-4)  are now supported, and they can be output with
-C<printf %a>.
+On platforms that are able to handle POSIX.1-2008, the
+hash returned by
+L<C<POSIX::localeconv()>|perllocale/The localeconv function>
+includes the international currency fields added by that version of the
+POSIX standard.  These are
+C<int_n_cs_precedes>,
+C<int_n_sep_by_space>,
+C<int_n_sign_posn>,
+C<int_p_cs_precedes>,
+C<int_p_sep_by_space>,
+and
+C<int_p_sign_posn>.
 
 =head1 Security
 
-=head2 The L<Safe> module could allow outside packages to be replaced
+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.
 
-Critical bugfix: outside packages could be replaced.  L<Safe> has
-been patched to 2.38 to address this.
+[ List each security issue as a =head2 entry ]
 
 =head1 Incompatible Changes
 
-=head2 S<C<use UNIVERSAL '...'>> is now a fatal error
-
-Importing functions from C<UNIVERSAL> has been deprecated since v5.12, and
-is now a fatal error.  S<C<"use UNIVERSAL">> without any arguments is still
-allowed.
-
-=head1 Modules and Pragmata
+XXX For a release on a stable branch, this section aspires to be:
 
-=head2 Updated 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.
 
-=over 4
+[ List each incompatible change as a =head2 entry ]
 
-=item *
+=head1 Deprecations
 
-L<B::Debug> has been upgraded from version 1.19 to 1.21.
+XXX Any deprecated features, syntax, modules etc. should be listed here.
 
-=item *
+=head2 Module removals
 
-L<Config::Perl::V> has been upgraded from version 0.20 to 0.22.
+XXX Remove this section if inapplicable.
 
-=item *
+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.
 
-L<CPAN::Meta> has been upgraded from version 2.141520 to 2.142060.
+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.
 
-=item *
+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.
 
-L<CPAN::Meta::Requirements> has been upgraded from version 2.125 to 2.126.
+=over
 
-=item *
+=item XXX
 
-L<ExtUtils::Manifest> has been upgraded from version 1.64 to 1.65.
+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.
 
-=item *
+=back
 
-L<HTTP::Tiny> has been upgraded from version 0.043 to 0.047.
+[ List each other deprecation as a =head2 entry ]
 
-=item *
+=head1 Performance Enhancements
 
-L<perl5db.pl> has been upgraded from version 1.45 to 1.46.
+XXX Changes which enhance performance without changing behaviour go here.
+There may well be none in a stable release.
 
-=item *
+[ List each enhancement as a =item entry ]
 
-L<POSIX> has been upgraded from version 1.41 to 1.42.
+=over 4
 
 =item *
 
-L<Safe> has been upgraded from version 2.37 to 2.38.
+C<length> is up to 20% faster for non-magical/non-tied scalars containing a
+string if it is a non-utf8 string or if C<use bytes;> is in scope.
 
 =item *
 
-L<Socket> has been upgraded from version 2.014 to 2.015.
+Non-magical/non-tied scalars that contain only a floating point value and are
+on most Perl builds with 64 bit integers now use 8-32 less bytes of memory
+depending on OS.
 
 =back
 
-=head1 Documentation
+=head1 Modules and Pragmata
 
-=head2 Changes to Existing Documentation
+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.
+
+[ Within each section, list entries as a =item entry ]
 
-=head3 L<perlexperiment>
+=head2 New Modules and Pragmata
 
 =over 4
 
 =item *
 
-Added reference to L<feature>.
+XXX
 
 =back
 
-=head3 L<perlguts>
+=head2 Updated Modules and Pragmata
 
 =over 4
 
 =item *
 
-Details on C level symbols and libperl.t added.
+L<Module::CoreList> has been upgraded from version 5.20140920 to 5.20141020.
+
+Updated to cover the latest releases of Perl.
 
 =back
 
-=head3 L<perlhacktips>
+=head2 Removed Modules and Pragmata
 
 =over 4
 
 =item *
 
-Recommended replacements for tmpfile, atoi, strtol, and strtoul added.
+XXX
 
 =back
 
-=head3 L<perlop>
-
-=over 4
-
-=item *
+=head1 Documentation
 
-ASCII v. EBCDIC clarifications added.
+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>.
 
-=back
+=head2 New Documentation
 
-=head3 L<perlsec>
+XXX Changes which create B<new> files in F<pod/> go here.
 
-=over 4
+=head3 L<XXX>
 
-=item *
+XXX Description of the purpose of the new file here
 
-Comments added on algorithmic complexity and tied hashes.
+=head2 Changes to Existing Documentation
 
-=back
+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<perlvms>
+=head3 L<XXX>
 
 =over 4
 
 =item *
 
-Updated documentation on environment and shell interaction in VMS.
+XXX Description of the change here
 
 =back
 
@@ -161,168 +192,224 @@ 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 *
 
-L<Hexadecimal float: internal error|perldiag/"Hexadecimal float: internal error">
+XXX L<message|perldiag/"message">
 
-(F) Something went horribly bad in hexadecimal float handling.
+=back
 
-=item *
+=head3 New Warnings
 
-L<Hexadecimal float: unsupported long double format|perldiag/"Hexadecimal float: unsupported long double format">
+=over 4
 
-(F) You have configured Perl to use long doubles but
-the internals of the long double format are unknown,
-therefore the hexadecimal float output is impossible.
+=item *
+
+XXX L<message|perldiag/"message">
 
 =back
 
-=head3 New Warnings
+=head2 Changes to Existing Diagnostics
+
+XXX Changes (i.e. rewording) of diagnostic messages go here
 
 =over 4
 
 =item *
 
-L<Hexadecimal float: exponent overflow|perldiag/"Hexadecimal float: exponent overflow">
-
-(W overflow) The hexadecimal floating point has larger exponent
-than the floating point supports.
+XXX Describe change here
 
-=item *
+=back
 
-L<Hexadecimal float: exponent underflow|perldiag/"Hexadecimal float: exponent underflow">
+=head1 Utility Changes
 
-(W overflow) The hexadecimal floating point has smaller exponent
-than the floating point supports.
+XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
+Most of these are built within the directory F<utils>.
 
-=item *
+[ 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. ]
 
-L<Hexadecimal float: mantissa overflow|perldiag/"Hexadecimal float: mantissa overflow">
+=head2 L<XXX>
 
-(W overflow) The hexadecimal floating point literal had more bits in
-the mantissa (the part between the 0x and the exponent, also known as
-the fraction or the significand) than the floating point supports.
+=over 4
 
 =item *
 
-L<Hexadecimal float: precision loss|perldiag/"Hexadecimal float: precision loss">
-
-(W overflow) The hexadecimal floating point had internally more
-digits than could be output.  This can be caused by unsupported
-long double formats, or by 64-bit integers not being available
-(needed to retrieve the digits under some configurations).
+XXX
 
 =back
 
-=head2 Changes to Existing Diagnostics
+=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 *
 
-C<require> with no argument or undef used to warn about a Null filename; now
-it dies with C<Missing or undefined argument to require>.
+XXX
 
 =back
 
-=head1 Configuration and Compilation
+=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 *
 
-MurmurHash64A and MurmurHash64B can now be configured as the internal hash
-function.
+XXX
 
 =back
 
 =head1 Platform Support
 
-=head2 Platform-Specific Notes
+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 Android
+=item XXX-some-platform
 
-Build support has been improved for cross-compiling in general and for
-Android in particular.
+XXX
 
-=item Solaris
+=back
 
-C<c99> options have been cleaned up, hints look for C<solstudio>
-as well as C<SUNWspro>, and support for native C<setenv> has been added.
+=head2 Discontinued Platforms
 
-=item VMS
+XXX List any platforms that this version of perl no longer compiles on.
 
-C<finite>, C<finitel>, and C<isfinite> detection has been added to
-C<configure.com>, environment handling has had some minor changes, and
-a fix for legacy feature checking status.
+=over 4
 
-=item Windows
+=item XXX-some-platform
 
-C<%I64d> is now being used instead of C<%lld> for MinGW.
+XXX
 
 =back
 
-=head1 Internal Changes
+=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 *
+=item XXX-some-platform
+
+XXX
 
-Added L<perlapi/sync_locale>.
-Changing the program's locale should be avoided by XS code.  Nevertheless,
-certain non-Perl libraries called from XS, such as C<Gtk> do so.  When this
-happens, Perl needs to be told that the locale has changed.  Use this function
-to do so, before returning to Perl.
+=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 *
 
-Added L<perlapi/grok_atou> as a safer replacement for atoi and strtol.
+XXX
 
 =back
 
 =head1 Selected Bug Fixes
 
+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>.
+
+[ List each fix as a =item entry ]
+
 =over 4
 
 =item *
 
-Failing to compile C<use Foo> in an eval could leave a spurious
-C<BEGIN> subroutine definition, which would produce a "Subroutine
-BEGIN redefined" warning on the next use of C<use>, or other C<BEGIN>
-block.  [perl #122107]
+XXX
+
+=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.  Unfixed
+platform specific bugs also go here.
+
+[ List each fix as a =item entry ]
+
+=over 4
 
 =item *
 
-C<method { BLOCK } ARGS> syntax now correctly parses the arguments if they
-begin with an opening brace.  [perl #46947]
+XXX
+
+=back
+
+=head1 Errata From Previous Releases
+
+=over 4
 
 =item *
 
-External libraries and Perl may have different ideas of what the locale is.
-This is problematic when parsing version strings if the locale's numeric
-separator has been changed.  Version parsing has been patched to ensure
-it handles the locales correctly.  [perl #121930]
+XXX Add anything here that we forgot to add, or were mistaken about, in
+the perldelta of a previous release.
 
 =item *
 
-A bug has been fixed where zero-length assertions and code blocks inside of a
-regex could cause C<pos> to see an incorrect value.  [perl #122460]
+SVs of type SVt_NV are now bodyless when a build configure and platform allow
+it, specifically C<sizeof(NV) <= sizeof(IV)>. The bodyless trick is the same one
+as for IVs since 5.9.2, but for NVs, unlike IVs, is not guarenteed on all
+platforms and build configurations.
 
 =back
 
+=head1 Obituary
+
+XXX If any significant core contributor has died, we've added a short obituary
+here.
+
 =head1 Acknowledgements
 
 XXX Generate this with:
 
-  perl Porting/acknowledgements.pl v5.21.2..HEAD
+  perl Porting/acknowledgements.pl v5.21.4..HEAD
 
 =head1 Reporting Bugs