This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
numeric.c: White-space only
[perl5.git] / pod / perldelta.pod
index a1efc33..062eef0 100644 (file)
 
 =head1 NAME
 
-perldelta - what is new for perl v5.33.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.35.3
 
 =head1 DESCRIPTION
 
-This document describes differences between the 5.33.8 release and the 5.33.9
+This document describes differences between the 5.35.2 release and the 5.35.3
 release.
 
-If you are upgrading from an earlier release such as 5.33.7, first read
-L<perl5338delta>, which describes differences between 5.33.7 and 5.33.8.
+If you are upgrading from an earlier release such as 5.35.1, first read
+L<perl5352delta>, which describes differences between 5.35.1 and 5.35.2.
 
-=head1 Modules and Pragmata
+=head1 Notice
 
-=head2 Updated Modules and Pragmata
+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
+
+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 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 *
 
-L<perlfaq> has been upgraded from version 5.20201107 to 5.20210411.
+XXX
 
-- Added entry to faq4 for equivalent to ruby #{}, python fstring
+=back
 
-=item *
+=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.
 
-L<ExtUtils::MakeMaker> has been upgraded from version 7.60 to 7.62
+The list of new and updated modules is modified automatically as part of
+preparing a Perl release, so the only reason to manually add entries here is if
+you're summarising the important changes in the module update. (Also, if the
+manually-added details don't match the automatically-generated ones, the
+release manager will have to investigate the situation carefully.)
 
-- Now using shellwords in ExtUtils::Liblist::Kid::_unix_os2_ext
+[ Within each section, list entries as an =item entry ]
+
+=head2 New Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<NEXT> has been upgraded from version 0.67 to 0.68
+XXX Remove this section if not applicable.
 
-- This aligns NEXT with changes already shipped with Perl as well as improving the test suite.
+=back
+
+=head2 Updated Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<ExtUtils::ParseXS> has been upgraded from version 3.42 to 3.43
+L<XXX> has been upgraded from version A.xx to B.yy.
 
-- Emphasize SvPVbyte and SvPVutf8 over SvPV in docs. Also includes minor output changes to clarify failure conditions.
+If there was something important to note about this change, include that here.
 
 =back
 
-=head1 Documentation
+=head2 Removed Modules and Pragmata
 
 =over 4
 
 =item *
 
-L<perlguts> now explains in greater detail the need to consult SvUTF8
-when calling SvPV (or variants). A new "How do I pass a Perl string to a C
-library?" section in the same document discusses when to use which style of
-macro to read an SV's string value.
+XXX
 
-L<perlapi>, L<perlguts>, L<perlxs>, and L<perlxstut> now prefer SvPVbyte
-over SvPV.
+=back
 
-=item *
+=head1 Documentation
 
-References to B<Pumpking> have been replaced with a more accurate term or B<Steering Council> where appropriate.
+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
 
-L<perldiag> now documents additional examples of "not imported" warnings.
+XXX Changes which create B<new> files in F<pod/> go here.
 
-=item *
+=head3 L<XXX>
 
-B<The Perl Steering Council> is now the fallback contact for security issues.
+XXX Description of the purpose of the new file here
 
-=item *
+=head2 Changes to Existing Documentation
 
-Simplify the split() documentation by removing the join()s from the examples (#18676)
+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>.
 
-Remove join() from split() examples as it confuses the concepts
+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.
 
-split() is a very basic function, and the documentation should be
-simple for novinces. The split() documentation contains a lot of join()
-in the examples which only serve to muddle the concepts. This replaces
-the join() in the example with output in comments.
+Additionally, the following selected changes have been made:
+
+=head3 L<XXX>
+
+=over 4
+
+=item *
+
+XXX Description of the change here
 
 =back
 
@@ -89,142 +182,228 @@ 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<Wide character in setenv key (encoding to utf8)|perldiag/"Wide character in %s">
+XXX L<message|perldiag/"message">
+
+=back
+
+=head3 New Warnings
+
+=over 4
+
+=item *
 
-Attempts to put wide characters into environment variable keys via C<%ENV> now
-provoke this warning.
+XXX L<message|perldiag/"message">
 
 =back
 
-=head1 Configuration and Compilation
+=head2 Changes to Existing Diagnostics
+
+XXX Changes (i.e. rewording) of diagnostic messages go here
 
 =over 4
 
 =item *
 
-Prevented incpath to spill into libpth
+XXX Describe change here
+
+=back
+
+=head1 Utility Changes
+
+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. ]
+
+=head2 L<XXX>
 
 =over 4
 
-=item - Use realpath if available.
+=item *
 
-=item - This might catch more duplicate paths.
+XXX
 
-=item - Only include real existing paths.
+=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 an =item entry ].
+
+=over 4
+
+=item *
 
-=item - Filter inc paths out of libpth.
+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.
+
+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 *
+
+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 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 Windows
+=item XXX-some-platform
 
-Reading non-ASCII characters from the console when its codepage was set to
-65001 (UTF-8) was broken due to a bug in Windows. A workaround for this
-problem has been implemented.
-[L<GH #18701|https://github.com/Perl/perl5/issues/18701>]
+XXX
 
 =back
 
-=head1 Internal Changes
+=head2 Discontinued Platforms
+
+XXX List any platforms that this version of perl no longer compiles on.
 
 =over 4
 
-=item *
+=item XXX-some-platform
+
+XXX
+
+=back
+
+=head2 Platform-Specific Notes
 
-Corrected handling of double and long double parameters for perl's
-implementation of formatted output for C<-Dusequadmath> builds.
+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.
 
-This applies to PerlIO_printf(), croak(), warn(), sv_catpvf() and
-their variants.
+=over 4
 
-Previously in C<quadmath> builds, code like:
+=item XXX-some-platform
 
-  PerlIO_printf(PerlIO_stderr(), "%g", somedouble);
+XXX
 
-or
+=back
 
-  PerlIO_printf(PerlIO_stderr(), "%Lg", somelongdouble);
+=head1 Internal Changes
 
-would erroneously throw an exception "panic: quadmath invalid format
-...", since the code added for quadmath builds assumed C<NV>s were the
-only floating point format passed into these functions.
+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.
 
-This code would also process the standard C long double specifier C<L>
-as if it expected an C<NV> (C<__float128> for quadmath builds),
-resulting in undefined behaviour.
+[ List each change as an =item entry ]
 
-These functions now correctly accept doubles, long doubles and NVs.
+=over 4
 
 =item *
 
-Previously the right operand of bitwise shift operators (shift amount)
-was implicitly cast from IV to int, but it might lead wrong results
-if IV does not fit in int.
-
-And also, shifting INT_MIN bits used to yield the shiftee unchanged
-(treated as 0-bit shift instead of negative shift).
+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 an =item entry ]
+
 =over 4
 
 =item *
 
-Setting %ENV now properly handles upgraded strings in the key. Previously
-Perl sent the SV's internal PV directly to the OS; now it will handle keys
-as it has handled values since 5.18: attempt to downgrade the string first;
-if that fails then warn and use the utf8 form.
+XXX
 
 =back
 
-=head1 Acknowledgements
+=head1 Known Problems
 
-Perl 5.33.9 represents approximately 4 weeks of development since Perl
-5.33.8 and contains approximately 3,900 lines of changes across 190 files
-from 23 authors.
+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.
 
-Excluding auto-generated files, documentation and release tools, there were
-approximately 780 lines of changes to 82 .pm, .t, .c and .h files.
+[ List each fix as an =item entry ]
 
-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.33.9:
+=over 4
+
+=item *
+
+XXX
+
+=back
+
+=head1 Errata From Previous Releases
+
+=over 4
+
+=item *
+
+XXX Add anything here that we forgot to add, or were mistaken about, in
+the perldelta of a previous release.
 
-Dan Book, Dominic Hamon, E. Choroba, Ed J, Felipe Gasper, H.Merijn Brand,
-Hugo van der Sanden, James E Keenan, John Lightsey, Karen Etheridge, Karl
-Williamson, Marc Reisner, Max Maischein, Nicolas R., Paul Evans, Ricardo
-Signes, Richard Leach, Scott Baker, TAKAI Kousuke, Todd Rinaldo, Tomasz
-Konojacki, Tony Cook, Михаил Козачков.
+=back
+
+=head1 Obituary
 
-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.
+XXX If any significant core contributor or member of the CPAN community has
+died, add a short obituary here.
+
+=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.2..HEAD
 
 =head1 Reporting Bugs