This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Generate the deprecation warnings for all uses $* or $#.
[perl5.git] / pod / perldelta.pod
index 6275020..3bce5f4 100644 (file)
 
 =head1 NAME
 
-perldelta - what is new for perl v5.17.9
+[ 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.10
 
 =head1 DESCRIPTION
 
-This document describes differences between the 5.17.8 release and the 5.17.9
+This document describes differences between the 5.17.9 release and the 5.17.10
 release.
 
-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 Core Enhancements
-
-=head2 Interpolations now Accepted in Regular Expression Set Operations
-
-Perl v5.17.8 introduced L<regular expression set operations|perlre/(?[ ])>.
-They have now been expanded to allow the interpolation of a
-previously-compiled set into a bigger set, like this:
-
- my $thai_or_lao = qr/\p{Thai} + \p{Lao}/;
- ...
- qr/(?[ \p{Digit} & $thai_or_lao ])/;
-
-=head1 Incompatible Changes
-
-=head2 C<$ENV{foo} = undef> no longer deletes value from environ
-
-5.17.3 Introduced a change where assiging C<undef> to an C<%ENV> key was equivalent
-to C<delete $ENV{foo}>.
-
-This release reverts that change.
-
-=head1 Deprecations
-
-The deprecation of lexical C<$_> in 5.17.7 has been commuted.  The feature
-is now marked experimental.
-
-=head2 Deprecated pragma
-
-=over
-
-=item L<encoding>
-
-This module is deprecated under perl 5.18.  It uses a mechanism provided by
-perl that is deprecated under 5.18 and higher, and may be removed in a
-future version.
-
-=back
-
-=head2 Deprecated Modules
-
-The following modules will be removed from the core distribution in a
-future release, and should be installed from CPAN instead. Distributions
-on CPAN which require these should add them to their prerequisites. The
-core versions of these modules C<warnings> will issue a deprecation warning.
-
-You can silence these deprecation warnings by installing the modules
-in question from CPAN.
-
-=over
-
-=item L<Archive::Extract>
-
-=item L<B::Lint>
-
-=item L<B::Lint::Debug>
-
-=item L<CPANPLUS>
-
-=item L<CPANPLUS::Backend>
-
-=item L<CPANPLUS::Backend::RV>
-
-=item L<CPANPLUS::Config>
-
-=item L<CPANPLUS::Config::HomeEnv>
-
-=item L<CPANPLUS::Configure>
-
-=item C<CPANPLUS::Configure::Setup>
-
-=item L<CPANPLUS::Dist>
+If you are upgrading from an earlier release such as 5.17.8, first read
+L<perl5179delta>, which describes differences between 5.17.8 and 5.17.9.
 
-=item L<CPANPLUS::Dist::Autobundle>
+=head1 Notice
 
-=item L<CPANPLUS::Dist::Base>
+XXX Any important notices here
 
-=item L<CPANPLUS::Dist::Build>
-
-=item L<CPANPLUS::Dist::Build::Constants>
-
-=item L<CPANPLUS::Dist::MM>
-
-=item L<CPANPLUS::Dist::Sample>
-
-=item L<CPANPLUS::Error>
-
-=item L<CPANPLUS::Internals>
-
-=item C<CPANPLUS::Internals::Constants>
-
-=item C<CPANPLUS::Internals::Constants::Report>
-
-=item L<CPANPLUS::Internals::Extract>
-
-=item L<CPANPLUS::Internals::Fetch>
-
-=item L<CPANPLUS::Internals::Report>
-
-=item L<CPANPLUS::Internals::Search>
-
-=item L<CPANPLUS::Internals::Source>
-
-=item L<CPANPLUS::Internals::Source::Memory>
-
-=item L<CPANPLUS::Internals::Source::SQLite>
-
-=item C<CPANPLUS::Internals::Source::SQLite::Tie>
-
-=item L<CPANPLUS::Internals::Utils>
-
-=item C<CPANPLUS::Internals::Utils::Autoflush>
-
-=item L<CPANPLUS::Module>
-
-=item L<CPANPLUS::Module::Author>
-
-=item L<CPANPLUS::Module::Author::Fake>
-
-=item L<CPANPLUS::Module::Checksums>
-
-=item L<CPANPLUS::Module::Fake>
-
-=item C<CPANPLUS::Module::Signature>
-
-=item L<CPANPLUS::Selfupdate>
-
-=item L<CPANPLUS::Shell>
-
-=item L<CPANPLUS::Shell::Classic>
-
-=item L<CPANPLUS::Shell::Default>
-
-=item L<CPANPLUS::Shell::Default::Plugins::CustomSource>
-
-=item L<CPANPLUS::Shell::Default::Plugins::Remote>
-
-=item L<CPANPLUS::Shell::Default::Plugins::Source>
-
-=item L<Devel::InnerPackage>
+=head1 Core Enhancements
 
-=item L<Log::Message>
+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.
 
-=item L<Log::Message::Config>
+[ List each enhancement as a =head2 entry ]
 
-=item L<Log::Message::Handlers>
+=head1 Security
 
-=item L<Log::Message::Item>
+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.
 
-=item L<Log::Message::Simple>
+[ List each security issue as a =head2 entry ]
 
-=item L<Module::Pluggable>
+=head1 Incompatible Changes
 
-=item L<Module::Pluggable::Object>
+=head2 Explicit rules for variable names and identifiers
 
-=item L<Object::Accessor>
+Due to an oversight, length-one variable names in 5.16 were completely
+unrestricted, and opened the door to several kinds of insanity.  As of
+5.18, these now follow the rules of other identifiers, in addition
+to accepting characters that match the \p{POSIX_Punct} property.
 
-=item L<Term::UI>
+There are no longer any differences in the parsing of identifiers specified
+as $... or ${...}; previously, they were dealt with in different parts of
+the core, and so had slightly different behavior. For instance,
+C<${foo:bar}> was a legal variable name.  Since they are now both parsed
+by the same code, that is no longer the case.
 
-=item L<Term::UI::History>
+[ List each incompatible change as a =head2 entry ]
 
-=back
-
-=head3 Deprecated Utilities
+=head1 Deprecations
 
-The following utilities will be removed from the core distribution in a
-future release as their associated modules have been deprecated. They
-will remain available with the applicable CPAN distribution.
+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.
 
-=over
+[ List each deprecation as a =head2 entry ]
 
-=item L<cpanp>
+=head2 PL_sv_objcount
 
-Included with L<CPANPLUS>.
+This interpreter-global variable used to track the total number of
+Perl objects in the interpreter. It is no longer maintained and will
+be removed altogether in Perl 5.20.
 
-=item C<cpanp-run-perl>
+=head1 Performance Enhancements
 
-Included with L<CPANPLUS>.
+XXX Changes which enhance performance without changing behaviour go here.
+There may well be none in a stable release.
 
-=item L<cpan2dist>
+[ List each enhancement as a =item entry ]
 
-Included with L<CPANPLUS>.
+=over 4
 
-=item L<pod2latex>
+=item *
 
-The L<Pod::LaTeX> module was deprecated with 5.17.8.
+XXX
 
 =back
 
-=head2 Five additional characters should be escaped in patterns with C</x>
-
-When a regular expression pattern is compiled with C</x>, Perl treats 6
-characters as white space to ignore, such as SPACE and TAB.  However,
-Unicode recommends 11 characters be treated thusly.  In preparation to
-conforming with this in a future Perl version, in the meantime, use of
-any of the missing characters will raise a deprecation warning, unless
-turned off.  The five characters are:
-U+0085 NEXT LINE,
-U+200E LEFT-TO-RIGHT MARK,
-U+200F RIGHT-TO-LEFT MARK,
-U+2028 LINE SEPARATOR,
-and
-U+2029 PARAGRAPH SEPARATOR.
-
 =head1 Modules and Pragmata
 
 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
@@ -233,9 +99,7 @@ cribbed.
 
 =item *
 
-L<Config::Perl::V> version 0.16 has been added as a dual-lifed module.
-It provides structured data retrieval of C<perl -V> output including
-information only known to the C<perl> binary and not available via L<Config>.
+XXX
 
 =back
 
@@ -245,47 +109,56 @@ information only known to the C<perl> binary and not available via L<Config>.
 
 =item *
 
-L<Benchmark> has been upgraded from version 1.13 to 1.14.
+L<Benchmark> has been upgraded from version 1.14 to 1.15.
 
-The "too few iterations" message is now a warning on STDERR
-instead of being output on STDOUT.
+This reverts (for now) a change in 1.14 whereby the "too few iterations"
+message became a warning on STDERR instead of being output on STDOUT. It's
+now on STDOUT again.
 
 =item *
 
-L<Data::Dumper> has been upgraded from version 2.141 to 2.142.
+L<Perl::OSType> has been upgraded from version 1.002 to 1.003.
 
-Additional tests were added in order to improve statement, branch, condition
-and subroutine coverage.  On the basis of the coverage analysis, some of the
-internals of Dumper.pm were refactored.  Almost all methods are now
-documented.
+This fixes a bug detecting the VOS operating system.
 
-=item *
+=back
 
-L<File::Temp> has been upgraded from version 0.22 to 0.22_90
+=head2 Removed Modules and Pragmata
 
-Fixes various bugs involving directory removal.  Defers unlinking tempfiles if
-the initial unlink fails, which fixes problems on NFS.
+=over 4
 
 =item *
 
-L<PerlIO::scalar> has been upgraded from version 0.15 to 0.16.
-
-The buffer scalar supplied may now only contain code pounts 0xFF or
-lower. [perl #109828]
+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<perlsec>
+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<perlrebackslash/\N>
 
 =over 4
 
 =item *
 
-A syntax error was fixed in one of illustrative examples.
+This feature is no longer experimental.
 
 =back
 
@@ -295,15 +168,31 @@ 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 *
+
+XXX L<message|perldiag/"message">
+
+=back
+
 =head3 New Warnings
 
 =over 4
 
 =item *
 
-Strings with code points over 0xFF may not be mapped into in-memory file handles
+XXX L<message|perldiag/"message">
 
 =back
 
@@ -313,170 +202,191 @@ Strings with code points over 0xFF may not be mapped into in-memory file handles
 
 =item *
 
-The warnings for \b{ and \B{ were added in the 5.17 series; they are a
-deprecation warning which should be turned off by that category.  One
-should not have to turn off regular regexp warnings as well to get rid
-of these.
+L<$* is no longer supported|perldiag/"$* is no longer supported">
+
+The warning that use of C<$*> and C<$#> is no longer supported is now
+generated for every location that references them.  Previously it would fail
+to be generated if another variable using the same typeglob was seen first
+(e.g. C<@*> before C<$*>), and would not be generated for the second and
+subsequent uses.  (It's hard to fix the failure to generate warnings at all
+without also generating them every time, and warning every time is
+consistent with the warnings that C<$[> used to generate.)
 
 =back
 
 =head1 Utility Changes
 
-=head3 L<corelist>
+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>.
 
-=over 4
+[ 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. ]
 
-=item *
+=head3 L<XXX>
 
-Added C<--feature> switch which lists the first version bundle of each
-named feature given.
+=over 4
 
 =item *
 
-Added C<--upstream> switch which shows if the given module
-is primarily maintained in perl core or on CPAN and bug tracker URL.
+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 ].
+
 =over 4
 
 =item *
 
-Added C<useversionedarchname> option to Configure
+XXX
 
-When set, it includes 'api_versionstring' in 'archname'. E.g.
-x86_64-linux-5.13.6-thread-multi.  It is unset by default.
+=back
 
-This feature was requested by Tim Bunce, who observed that
-INSTALL_BASE creates a library structure that does not
-differentiate by perl version.  Instead, it places architecture
-specific files in "$install_base/lib/perl5/$archname".  This makes
-it difficult to use a common INSTALL_BASE library path with
-multiple versions of perl.
+=head1 Testing
 
-By setting -Duseversionedarchname, the $archname will be
-distinct for architecture *and* API version, allowing mixed use of
-INSTALL_BASE.
+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.
 
-=item *
+[ List each test improvement as a =item entry ]
 
-Configure will honour the external C<MAILDOMAIN> environment variable, if set.
+=over 4
 
 =item *
 
-C<installman> no longer ignores the silent option
+XXX
 
-=item *
+=back
 
-Both C<META.yml> and C<META.json> files are now included in the distribution.
+=head1 Platform Support
 
-=back
+XXX Any changes to platform support should be listed in the sections below.
 
-=head1 Testing
+[ Within the sections, list each platform as a =item entry with specific
+changes as paragraphs below it. ]
 
-=over 4
+=head2 New Platforms
 
-=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.
 
-Enable perl core tests to pass when locale support is not available.
+=over 4
 
-use L<locale> - this will now die if $Config{d_setlocale} is not true.
-All tests that use L<locale> will skip if $Config{d_setlocale} is not true.
-This enables us to pass tests on Android which uses ICU instead of locales.
+=item XXX-some-platform
+
+XXX
 
 =back
 
-=head1 Platform Support
+=head2 Discontinued Platforms
 
-=head2 Platform-Specific Notes
+XXX List any platforms that this version of perl no longer compiles on.
 
 =over 4
 
-=item VMS
+=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.
 
-The character set for Extended Filename Syntax (EFS) is now enabled by default on
-VMS.  Among other things, this provides better handling of dots in directory names,
-multiple dots in filenames,and spaces in filenames.  To obtain the old behavior,
-set the logical name C<DECC$EFS_CHARSET> to C<DISABLE>.
+=over 4
 
-=item MidnightBSD
+=item XXX-some-platform
 
-C<libc_r> was removed from recent versions of MidnightBSD and older versions
-work better with C<pthread>. Threading is now enabled using C<pthread> which
-corrects build errors with threading enabled on 0.4-CURRENT.
+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 *
 
-Synonyms for the misleadingly named C<av_len()> has been created:
-C<av_top_index()> and C<av_tindex>.  All three of these return the
-number of the highest index in the array, not the number of elements it
-contains.  (The name C<av_top> which was introduced in Perl v.5.17.8 has
-been removed.)
+The new copy-on-write mechanism that was introduced in 5.17.7 has now been
+disabled by default, since it was felt that there were too many rough
+edges for the 5.18 release. It is expected that it will be enabled by
+default for 5.20.
+
+This change also re-enables PL_sawampersand by default.
+
+It can be enabled in a perl build by running F<Configure> with
+B<-Accflags=-DPERL_NEW_COPY_ON_WRITE>, and we would encourage XS authors to
+try their code with such an enabled perl, and provide feedback.
+XXX need blurb, e.g. a reference to a new section in perlguts or perlxs
+explaining how XS authors should handle COW strings.
+
 
 =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 *
 
--DPERL_GLOBAL_STRUCT builds now free the global struct B<after>
-they've finished using it.
+Fix two crashes in the debugger when using Frame=2 or autotrace.  These are
+[perl #116769] and [perl #116771].
 
-=item *
+=back
 
-A trailing '/' on a path in @INC will no longer have an additional '/' appended.
+=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.
+
+[ List each fix as a =item entry ]
 
-The C<:crlf> layer now works when unread data doesn't fit into its own
-buffer. [perl #112244].
+=over 4
 
 =item *
 
-C<ungetc()> now handles UTF-8 encoded data. [perl #116322].
+XXX
 
 =back
 
+=head1 Obituary
+
+XXX If any significant core contributor has died, we've added a short obituary
+here.
+
 =head1 Acknowledgements
 
-Perl 5.17.9 represents approximately 4 weeks of development since Perl 5.17.8
-and contains approximately 42,000 lines of changes across 510 files from 35
-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.9:
-
-!, Aaron Crane, Alan Haggai Alavi, Alexandr Ciornii, Andy Dougherty, Brad
-Gilbert, Chris 'BinGOs' Williams, Christian Hansen, Craig A. Berry, Dagfinn
-Ilmari Mannsåker, Daniel Dragan, Dave Rolsky, David Golden, David Mitchell,
-Father Chrysostomos, H.Merijn Brand, James E Keenan, Jan Dubois, Jerry D.
-Hedden, Jess Robinson, Karl Williamson, Kent Fredric, Leon Timmermans, Lucas
-Holt, Matthew Horsfall, Nicholas Clark, Peter Martini, Rafael Garcia-Suarez,
-Ricardo Signes, Smylers, Steffen Müller, Steve Hay, Thomas Sibley, Tobias
-Leich, 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.
+XXX Generate this with:
+
+  perl Porting/acknowledgements.pl v5.17.9..HEAD
 
 =head1 Reporting Bugs