This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
No longer print experimental::isa warning (closes #18754)
[perl5.git] / pod / perldelta.pod
index 87a2271..39261f9 100644 (file)
 
 =head1 NAME
 
-perldelta - what is new for perl v5.35.4
+[ 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.35.9
 
 =head1 DESCRIPTION
 
-This document describes differences between the 5.35.3 release and the 5.35.4
+This document describes differences between the 5.35.8 release and the 5.35.9
 release.
 
-If you are upgrading from an earlier release such as 5.35.2, first read
-L<perl5353delta>, which describes differences between 5.35.2 and 5.35.3.
+If you are upgrading from an earlier release such as 5.35.7, first read
+L<perl5358delta>, which describes differences between 5.35.7 and 5.35.8.
+
+=head1 Notice
+
+XXX Any important notices here
 
 =head1 Core Enhancements
 
-=head2 C<defer> blocks
+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 ]
+
+=head2 @_ is now experimental within signatured subs
+
+Even though subroutine signatures currently remain experimental, use of the
+default arguments array (C<@_>) with a subroutine that has a signature is
+specifically also experimental, with its own warning category.  Silencing the
+C<experimental::signatures> warning category is not sufficient to dismiss
+this.  The new warning is emitted with the category name
+C<experimental::args_array_with_signatures>.
+
+Any subroutine that has a signature and tries to make use of the defaults
+argument array or an element thereof (C<@_> or C<$_[INDEX]>), either
+explicitly or implicitly (such as C<shift> or C<pop> with no argument) will
+provoke a warning at compile-time:
+
+    use experimental 'signatures';
+
+    sub f ($x, $y = 123) {
+      say "The first argument is $_[0]";
+    }
 
-This release adds support for C<defer> blocks, which are blocks of code
-prefixed by the C<defer> modifier. They provide a section of code which runs
-at a later time, during scope exit.
+Z<>
 
-For more information, see L<perlsyn/"defer blocks">.
+    Use of @_ in array element with signatured subroutine is experimental
+    at file.pl line 4.
 
-=head2 Unicode 14.0 is supported
+The behaviour of code which attempts to do this is no longer specified, and
+may be subject to change in a future version.
 
-See L<https://www.unicode.org/versions/Unicode14.0.0/> for details.
+=head2 The C<isa> operator is no longer experimental
 
-=head2 SIGFPE no longer deferred
+Introduced in Perl version 5.32.0, this operator has remained unchanged
+since then. The operator is now considered a stable languauge feature.
 
-Floating-point exceptions are now delivered immediately, in the same way
-as other "fault"-like signals such as SIGSEGV. This means one has at
-least a chance to catch such a signal with a C<$SIG{FPE}> handler, e.g.
-so that C<die> can report the line in perl that triggered it.
+For more detail see L<perlop/Class Instance Operator>.
 
-=head2 Stable boolean tracking
+=head1 Security
 
-The "true" and "false" boolean values, often accessed by constructions like
-C<!!0> and C<!!1>, as well as being returned from many core functions and
-operators, now remember their boolean nature even through assignment into
-variables. The new function C<isbool()> in L<Scalar::Util> can check whether
-a value has boolean nature.
+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.
 
-This is likely to be useful when interoperating with other languages or
-data-type serialisation, among other places.
+[ List each security issue as a =head2 entry ]
 
 =head1 Incompatible Changes
 
-There are no changes intentionally incompatible with 5.35.4.
-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:
+
+    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
+
+XXX Any deprecated features, syntax, modules etc. should be listed here.
+
+=head2 Downgrading a C<use VERSION> statement to below v5.11
+
+Attempting to issue a second C<use VERSION> statement that requests a version
+lower than C<v5.11> when an earlier statement that requested a version at
+least C<v5.11> has already been seen, will now print a deprecation warning.
+
+For example:
+
+    use v5.14;
+    say "The say statement is permitted";
+    use v5.8;                               # This will print a warning
+    print "We must use print\n";
+
+This is because of an intended related change to the interaction between
+C<use VERSION> and C<use strict>. If you specify a version >= 5.11, strict is
+enabled implicitly. If you request a version < 5.11, strict will become
+disabled I<even if you had previously written> C<use strict>. This was not
+the previous behaviour of C<use VERSION>, which at present will track
+explicitly-enabled strictness flags independently.
+
+Code which wishes to mix versions in this manner should use lexical scoping
+with block syntax to ensure that the differently versioned regions remain
+lexically isolated.
+
+    {
+        use v5.14;
+        say "The say statement is permitted";
+    }
+    {
+        use v5.8;                           # No warning is emitted
+        print "We must use print\n";
+    }
+
+=head2 Module removals
+
+XXX Remove this section if not applicable.
+
+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 an =item entry ]
+
 =over 4
 
 =item *
 
-We now probe for compiler support for C11 thread local storage, and where
-available use this for "implicit context" for XS extensions making API calls for
-a threaded Perl build.  This requires fewer function calls at the C level than
-POSIX thread specific storage. We continue to use the the pthreads approach if
-the C11 approach is not available.
-
-F<Configure> run with the defaults will build an unthreaded Perl (which is
-slightly faster), but most operating systems ship a threaded Perl.
+XXX
 
 =back
 
@@ -103,19 +197,6 @@ L<XXX> has been upgraded from version A.xx to B.yy.
 
 If there was something important to note about this change, include that here.
 
-=item *
-
-L<Text::Tabs> has been upgraded from version 2021.0717 to 2021.0814.
-
-=item *
-
-L<Text::Wrap> has been upgraded from version 2021.0717 to 2021.0814.
-
-=item *
-
-L<Unicode::Collate> has been upgraded from version 1.30 to 1.31.  Experimental
-support for EBCDIC has been added.
-
 =back
 
 =head2 Removed Modules and Pragmata
@@ -130,21 +211,36 @@ XXX
 
 =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
 
 We have attempted to update the documentation to reflect the changes
 listed in this document.  If you find any we have missed, open an issue
 at L<https://github.com/Perl/perl5/issues>.
 
+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.
+
 Additionally, the following selected changes have been made:
 
-=head3 L<perlre>
+=head3 L<XXX>
 
 =over 4
 
 =item *
 
-Updated to discourage the use of the /d regexp modifier.
+XXX Description of the change here
 
 =back
 
@@ -154,19 +250,21 @@ 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<Can't "%s" out of a defer block|perldiag/"Can't "%s" out of a defer block">
-
-(F) An attempt was made to jump out of the scope of a defer block by using
-a control-flow statement such as C<return>, C<goto> or a loop control. This is
-not permitted.
+XXX L<message|perldiag/"message">
 
 =back
 
@@ -176,140 +274,209 @@ not permitted.
 
 =item *
 
-L<defer is experimental|perldiag/"defer is experimental">
-
-(S experimental::defer) The C<defer> block modifier is experimental. If you
-want to use the feature, disable the warning with
-C<no warnings 'experimental::defer'>, but know that in doing so you are taking
-the risk that your code may break in a future Perl version.
+XXX L<message|perldiag/"message">
 
 =back
 
 =head2 Changes to Existing Diagnostics
 
-=over 4
+XXX Changes (i.e. rewording) of diagnostic messages go here
 
-=item "unexpected constant lvalue entersub entry via type/targ %d:%d" now has a panic prefix
+=over 4
 
-This makes it consistent with other checks of internal consistency when
-compiling a subroutine.
+=item *
 
-=item Removed a number of diagnostics
+L<Subroutine %s redefined|perldiag/"Subroutine %s redefined">
 
-Commit 6a3871b339 removes many diagnostics that have been removed from the
-perl core across many years.
+Localized subroutine redefinitions no longer trigger this warning.
 
 =back
 
-=head2 Platform-Specific Notes
+=head1 Utility Changes
 
-=over 4
+XXX Changes to installed programs such as F<perldoc> and F<xsubpp> go here.
+Most of these are built within the directory F<utils>.
+
+[ 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. ]
 
-=item C<keys %ENV> on VMS returns consistent results
+=head2 L<XXX>
 
-On VMS entries in the C<%ENV> hash are loaded from the OS environment on
-first access, hence the first iteration of C<%ENV> requires the entire
-environment to be scanned to find all possible keys. This initialisation had
-always been done correctly for full iteration, but previously was not
-happening for C<%ENV> in scalar context, meaning that C<scalar %ENV> would
-return 0 if called before any other C<%ENV> access, or would only return the
-count of keys accessed if there had been no iteration.
+=over 4
+
+=item *
 
-These bugs are now fixed - C<%ENV> and C<keys %ENV> in scalar context now
-return the correct result - the count of all keys in the environment.
+XXX
 
 =back
 
-=head1 Internal Changes
+=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 an =item entry ].
 
 =over 4
 
 =item *
 
-C<Perl_ptr_table_clear> has been deleted. This has been marked as deprecated
-since v5.14.0 (released in 2011), and is not used by any code on CPAN.
+XXX
+
+=back
+
+=head1 Testing
 
-=item *
+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.
 
-Added new boolean macros and functions. See L</Stable boolean tracking> for
-related information and L<perlapi> for documentation.
+XXX If there were no significant test changes, say this:
+
+Tests were added and changed to reflect the other additions and changes
+in this release.
+
+XXX If instead there were significant changes, say this:
+
+Tests were added and changed to reflect the other additions and
+changes in this release.  Furthermore, these significant changes were
+made:
+
+[ List each test improvement as an =item entry ]
 
 =over 4
 
 =item *
 
-sv_setbool
+XXX
 
-=item *
+=back
 
-sv_setbool_mg
+=head1 Platform Support
 
-=item *
+XXX Any changes to platform support should be listed in the sections below.
 
-SvIsBOOL
+[ Within the sections, list each platform as an =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 XXX-some-platform
+
+XXX
 
 =back
 
-=item *
+=head2 Discontinued Platforms
 
-Added 4 missing functions for dealing with RVs:
+XXX List any platforms that this version of perl no longer compiles on.
 
 =over 4
 
-=item *
+=item XXX-some-platform
 
-sv_setrv_noinc
+XXX
 
-=item *
+=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
 
-sv_setrv_noinc_mg
+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 an =item entry ]
+
+=over 4
 
 =item *
 
-sv_setrv_inc
+New equality-test functions C<sv_numeq> and C<sv_streq> have been added, along
+with C<..._flags>-suffixed variants.  These expose a simple and consistent API
+to perform numerical or string comparison which is aware of operator
+overloading.
+
+=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 an =item entry ]
+
+=over 4
 
 =item *
 
-sv_setrv_inc_mg
+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 an =item entry ]
+
+=over 4
+
 =item *
 
-C<xs_handshake()>'s two failure modes now provide distinct messages.
+XXX
 
 =back
 
-=head1 Acknowledgements
+=head1 Errata From Previous Releases
+
+=over 4
 
-Perl 5.35.4 represents approximately 4 weeks of development since Perl
-5.35.3 and contains approximately 64,000 lines of changes across 540 files
-from 19 authors.
+=item *
+
+XXX Add anything here that we forgot to add, or were mistaken about, in
+the perldelta of a previous release.
 
-Excluding auto-generated files, documentation and release tools, there were
-approximately 49,000 lines of changes to 310 .pm, .t, .c and .h files.
+=back
 
-Perl continues to flourish into its fourth decade thanks to a vibrant
-community of users and developers. The following people are known to have
-contributed the improvements that became Perl 5.35.4:
+=head1 Obituary
 
-Aristotle Pagaltzis, Chris 'BinGOs' Williams, Dagfinn Ilmari MannsÃ¥ker, Dan
-Book, David Mitchell, Felipe Gasper, Hugo van der Sanden, James E Keenan,
-Karen Etheridge, Karl Williamson, Matthew Horsfall, Nicholas Clark, Paul
-Evans, Richard Leach, TAKAI Kousuke, Todd Rinaldo, Tomasz Konojacki,
-Tomoyuki Sadahiro, Tony Cook, Unicode Consortium.
+XXX If any significant core contributor or member of the CPAN community has
+died, add 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.35.8..HEAD
 
 =head1 Reporting Bugs