This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
(toke|regcomp).c: Use common fcn to handle \0 problems
[perl5.git] / pod / perldelta.pod
index efe9888..8611b58 100644 (file)
 
 =head1 NAME
 
-perldelta - what is new for perl v5.31.8
+[ 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.31.9
 
 =head1 DESCRIPTION
 
-This document describes differences between the 5.31.7 release and the 5.31.8
+This document describes differences between the 5.31.8 release and the 5.31.9
 release.
 
-If you are upgrading from an earlier release such as 5.31.6, first read
-L<perl5317delta>, which describes differences between 5.31.6 and 5.31.7.
+If you are upgrading from an earlier release such as 5.31.7, first read
+L<perl5318delta>, which describes differences between 5.31.7 and 5.31.8.
 
 =head1 Notice
 
-We are now in the Contentious Changes Freeze portion of the 5.31.X release
-cycle.
+XXX Any important notices here
 
-=head1 Performance Enhancements
+=head1 Core Enhancements
 
-=over 4
+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 *
+[ List each enhancement as a =head2 entry ]
 
-C<my_strnlen> has been sped up for systems that don't have their own
-C<strnlen> implementation.
+=head1 Security
 
-=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.
 
-C<grok_bin_oct_hex> (and so, C<grok_bin>, C<grok_oct>, and C<grok_hex>)
-have been sped up.
+[ List each security issue as a =head2 entry ]
 
-=item *
+=head1 Incompatible Changes
 
-C<grok_number_flags> has been sped up.
+XXX For a release on a stable branch, this section aspires to be:
 
-=back
+    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.
 
-=head1 Modules and Pragmata
+[ List each incompatible change as a =head2 entry ]
 
-=head2 Updated Modules and Pragmata
+=head1 Deprecations
 
-=over 4
+XXX Any deprecated features, syntax, modules etc. should be listed here.
 
-=item *
+=head2 Module removals
 
-L<autodie> has been upgraded from version 2.29 to 2.32.
+XXX Remove this section if not applicable.
 
-=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<DB_File> has been upgraded from version 1.852 to 1.853.
+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<Encode> has been upgraded from version 3.01 to 3.02.
+=over
 
-=item *
+=item XXX
 
-L<ExtUtils::MakeMaker> has been upgraded from version 7.42 to 7.44.
+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<Hash::Util> has been upgraded from version 0.22 to 0.23.
+[ List each other deprecation as a =head2 entry ]
 
-The Synopsis has been updated as the example code stopped working with
-newer perls.
+=head1 Performance Enhancements
 
-[L<GH #17399|https://github.com/Perl/perl5/issues/17399>]
+XXX Changes which enhance performance without changing behaviour go here.
+There may well be none in a stable release.
 
-=item *
+[ List each enhancement as an =item entry ]
 
-L<IO> has been upgraded from version 1.41 to 1.42.
+=over 4
 
 =item *
 
-L<Module::CoreList> has been upgraded from version 5.20191220 to 5.20200120.
+XXX
 
-=item *
+=back
+
+=head1 Modules and Pragmata
 
-L<podlators> has been upgraded from version 4.12 to 4.14.
+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.
 
-=item *
+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.)
 
-L<POSIX> has been upgraded from version 1.90 to 1.91.
+[ Within each section, list entries as an =item entry ]
+
+=head2 New Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<Term::ANSIColor> has been upgraded from version 4.06 to 5.01.
+XXX Remove this section if not applicable.
+
+=back
+
+=head2 Updated Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<Test::Simple> has been upgraded from version 1.302170 to 1.302171.
+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.
+
+=back
+
+=head2 Removed Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<XS::APItest> has been upgraded from version 1.05 to 1.06.
+XXX
 
 =back
 
 =head1 Documentation
 
-=head2 Changes to Existing 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>.
 
-We have attempted to update the documentation to reflect the changes
-listed in this document.  If you find any we have missed, send email
-to L<https://github.com/Perl/perl5/issues>.
+=head2 New Documentation
 
-Additionally, the following selected changes have been made:
+XXX Changes which create B<new> files in F<pod/> go here.
 
-=head3 L<perlapi>
+=head3 L<XXX>
 
-=over 4
+XXX Description of the purpose of the new file here
 
-=item *
+=head2 Changes to Existing Documentation
 
-C<sv_2pvbyte> updated to mention it will croak if the SV cannot be
-downgraded.
+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>.
 
-=item *
+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.
 
-C<sv_setpvn> updated to mention that the UTF-8 flag will not be changed by
-this function, and a terminating NUL byte is guaranteed.
+Additionally, the following selected changes have been made:
 
-=item *
+=head3 L<XXX>
 
-Documentation for C<PL_phase> has been added.
+=over 4
 
 =item *
 
-The documentation for C<grok_bin>, C<grok_oct>, and C<grok_hex> has been
-updated and clarified.
+Links to the now defunct L<https://search.cpan.org> site now point at
+the equivalent L<https://metacpan.org> URL.  [GH #17393]
 
 =back
 
-=head3 L<perlguts>
+=head1 Diagnostics
 
-=over 4
+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>.
 
-=item *
+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.
 
-Don't suggest using perl's C<malloc> anymore. Modern system C<malloc> is
-assumed to be much better than perl's implementation at this point.
+=head2 New Diagnostics
 
-=back
+XXX Newly added diagnostic messages go under here, separated into New Errors
+and New Warnings
 
-=head3 L<perlintro>
+=head3 New Errors
 
 =over 4
 
 =item *
 
-The docs for the repetition operator C<x> have been clarified
-
-[L<GH #17335|https://github.com/Perl/perl5/issues/17335>]
+XXX L<message|perldiag/"message">
 
 =back
 
-=head3 L<perlipc>
+=head3 New Warnings
 
 =over 4
 
 =item *
 
-The documentation surrounding C<open> and handle usage has been modernized
-to prefer 3-arg open and lexical variables instead of barewords.
+L<Code point 0x%X is not Unicode, and not portable|perldiag/"Code point 0x%X is not Unicode, and not portable">
 
-=item *
+This is actually not a new message, but it is now output when the
+warnings category C<portable> is enabled.
 
-Various updates and fixes including making all examples strict-safe and
-replacing C<-w> with C<use warnings>.
+When raised during regular expression pattern compilation, the warning
+has extra text added at the end marking where precisely in the pattern
+it occured.
 
-=back
+=item *
 
-=head3 L<perlport>
+L<Non-hex character '%c' terminates \x early.  Resolved as "%s"|perldiag/"Non-hex character '%c' terminates \x early.  Resolved as "%s"">
 
-=over 4
+This replaces a warning that was much less specific, and which gave
+false information.  This new warning parallels the similar
+already-existing one raised for C<\o{}>.
 
 =item *
 
-Update C<timegm> example to use correct year format I<1970> instead of I<70>.
-
-[L<GH #16431|https://github.com/Perl/perl5/issues/16431>]
+L<message|perldiag/"message">
 
 =back
 
-=head3 L<perlvar>
+=head2 Changes to Existing Diagnostics
+
+XXX Changes (i.e. rewording) of diagnostic messages go here
 
 =over 4
 
 =item *
 
-Recommend stringifying C<$]> and comparing it numerically.
+L<Character following "\c" must be printable ASCII|perldiag/"Character following "\c" must be printable ASCII">
 
-=back
+now has extra text added at the end, when raised during regular
+expression pattern compilation, marking where precisely in the pattern
+it occured.
 
-=head3 L<perlxs>
+=item *
 
-=over 4
+L<Use "%s" instead of "%s"|perldiag/"Use "%s" instead of "%s"">
+
+now has extra text added at the end, when raised during regular
+expression pattern compilation, marking where precisely in the pattern
+it occured.
 
 =item *
 
-Suggest using libffi for simple library bindings.
+L<Sequence "\c{" invalid|perldiag/"Sequence "\c{" invalid">
 
-=back
+now has extra text added at the end, when raised during regular
+expression pattern compilation, marking where precisely in the pattern
+it occured.
 
-=head3 L<POSIX>
+=item *
 
-=over 4
+L<"\c%c" is more clearly written simply as "%s"|perldiag/""\c%c" is more clearly written simply as "%s"">
+
+now has extra text added at the end, when raised during regular
+expression pattern compilation, marking where precisely in the pattern
+it occured.
 
 =item *
 
-C<setlocale> warning about threaded builds updated to note it does not
-apply on Perl 5.28.X and later.
+L<Non-octal character '%c' terminates \o early.  Resolved as "%s"|perldiag/"Non-octal character '%c' terminates \o early.  Resolved as "%s"">
+
+now includes the phrase "terminates \o early", and has extra text added
+at the end, when raised during regular expression pattern compilation,
+marking where precisely in the pattern it occured.  In some instances
+the text of the resolution has been clarified.
 
 =item *
 
-C<< Posix::SigSet->new(...) >> updated to state it throws an error if any of
-the supplied signals cannot be added to the set.
+L<'%s' resolved to '\o{%s}%d'|perldiag/'%s' resolved to '\o{%s}%d'>
+
+As of Perl 5.32, this message is no longer generated.  Instead,
+L<perldiag/Non-octal character '%c' terminates \o early.  Resolved as "%s">
+is.
 
 =back
 
-=head1 Diagnostics
+=head1 Utility Changes
 
-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 Changes to installed programs such as F<perldoc> and F<xsubpp> go here.
+Most of these are built within the directory F<utils>.
 
-=head2 Changes to Existing Diagnostics
+[ 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 *
 
-The "Code point 0x%X is not Unicode, and not portable" warning removed
-the line "Code points above 0xFFFF_FFFF require larger than a 32 bit word."
-as code points that large are no longer legal on 32-bit platforms.
+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 an =item entry ].
+
 =over 4
 
 =item *
 
-For clang++, add C<< #include <stdlib.h> >> to Configure's probes for
-C<futimes>, C<strtoll>, C<strtoul>, C<strtoull>, C<strtouq>, otherwise the
-probes would fail to compile.
+XXX
 
-=item *
+=back
 
-Use a compile and run test for C<lchown> to satisfy clang++ which should
-more reliably detect it.
+=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.
 
-For C++ compilers, add C<< #include <stdio.h> >> to Configure's probes for
-C<getpgrp> and C<setpgrp> as they use printf and C++ compilers may fail
-compilation instead of just warning.
+XXX If there were no significant test changes, say this:
 
-=back
+Tests were added and changed to reflect the other additions and changes
+in this release.
 
-=head1 Testing
+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 *
 
-Certain test output of scalars containing control characters and Unicode
-has been fixed on EBCDIC.
+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 an =item entry with specific
+changes as paragraphs below it. ]
 
-=item NetBSD 8.0
+=head2 New Platforms
 
-Fix compilation of Perl on NetBSD 8.0 with g++.
+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.
 
-[L<GH #17381|https://github.com/Perl/perl5/issues/17381>]
+=over 4
 
-=item Solaris
+=item XXX-some-platform
 
-Configure now uses the detected types for gethostby* functions, allowing
-Perl to once again compile on certain configurations of Solaris.
+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
 
-C<savepvn>'s len parameter is now a C<Size_t> instead of an C<I32> since we
-can handle longer strings than 31 bits.
+XXX
 
 =back
 
-=head1 Selected Bug Fixes
+=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 VMS
+
+With the release of the patch kit C99 V2.0, VSI has provided support for a
+number of previously-missing C99 features.  On systems with that patch kit
+installed, Perl's configuration process will now detect the presence of the
+header C<stdint.h> and the following functions: C<fpclassify>, C<isblank>, C<isless>,
+C<llrint>, C<llrintl>, C<llround>, C<llroundl>, C<nearbyint>, C<round>, C<scalbn>,
+and C<scalbnl>.
 
-A heap-buffer-overflow has been fixed in the regular expression engine.
+=back
 
-[L<GH #17384|https://github.com/Perl/perl5/issues/17384>]
+=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.
 
-Fix an assertion failure in the regular expression engine.
+[ List each change as an =item entry ]
 
-[L<GH #17372|https://github.com/Perl/perl5/issues/17372>]
+=over 4
 
 =item *
 
-Fix regression in C<tr///> added somewhere in v5.31.6.
+XXX
 
-[L<GH #17391|https://github.com/Perl/perl5/issues/17391>]
+=back
 
-=item *
+=head1 Selected Bug Fixes
 
-Fix coredump in pp_hot.c after C<B::UNOP_AUX::aux_list()>.
+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>.
 
-[L<GH #17301|https://github.com/Perl/perl5/issues/17301>]
+[ List each fix as an =item entry ]
+
+=over 4
 
 =item *
 
-Commit bc62bf8519  ("Add some defensive coding to av_store()" has been
-reverted as it broke I<List-UtilsBy-XS-0.05> in v5.31.2.
+XXX
+
+=back
 
-[L<GH #17265|https://github.com/Perl/perl5/issues/17265>]
+=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.
 
-Loading IO is now threadsafe.
+[ List each fix as an =item entry ]
+
+=over 4
+
+=item *
 
-[L<GH #14816|https://github.com/Perl/perl5/issues/14816>]
+XXX
 
 =back
 
-=head1 Acknowledgements
+=head1 Errata From Previous Releases
 
-Perl 5.31.8 represents approximately 4 weeks of development since Perl
-5.31.7 and contains approximately 16,000 lines of changes across 400 files
-from 25 authors.
+=over 4
 
-Excluding auto-generated files, documentation and release tools, there were
-approximately 8,300 lines of changes to 260 .pm, .t, .c and .h files.
+=item *
 
-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.31.8:
+XXX Add anything here that we forgot to add, or were mistaken about, in
+the perldelta of a previous release.
 
-Andy Dougherty, Bernhard M. Wiedemann, Chad Granum, Chase Whitener, Chris
-'BinGOs' Williams, Craig A. Berry, Dan Book, Dan Kogai, David Mitchell,
-Felipe Gasper, Hugo van der Sanden, James E Keenan, Karl Williamson, Matthew
-Horsfall, Nicholas Clark, Nicolas R., Ricardo Signes, Russ Allbery, Santtu
-Ojanperä, Slaven Rezic, Smylers, Todd Rinaldo, Tomasz Konojacki, Tony Cook,
-Yves Orton.
+=back
 
-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 Obituary
+
+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.31.8..HEAD
 
 =head1 Reporting Bugs