diff options
author | Steve Hay <steve.m.hay@googlemail.com> | 2023-04-10 19:28:40 +0100 |
---|---|---|
committer | Steve Hay <steve.m.hay@googlemail.com> | 2023-04-10 19:28:40 +0100 |
commit | d554897e3148841e7c87ff27199db9ce37b50933 (patch) | |
tree | 914740ea2ceb45eb196231d7e48e086c5b4b5ccd | |
parent | c1120f5156faebe09192c1e23eb27f597dedfaea (diff) | |
download | perl-d554897e3148841e7c87ff27199db9ce37b50933.tar.gz |
perldelta - Remove boilerplate
-rw-r--r-- | pod/perldelta.pod | 397 |
1 files changed, 23 insertions, 374 deletions
diff --git a/pod/perldelta.pod b/pod/perldelta.pod index 0deec8aad1..dbd185765d 100644 --- a/pod/perldelta.pod +++ b/pod/perldelta.pod @@ -2,9 +2,6 @@ =head1 NAME -[ 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.36.1 =head1 DESCRIPTION @@ -15,110 +12,14 @@ release. If you are upgrading from an earlier release such as 5.35.0, first read L<perl5360delta>, which describes differences between 5.35.0 and 5.36.0. -=head1 Notice - -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 * - -XXX - -=back +There are no changes intentionally incompatible with 5.36.0. If any exist, +they are bugs, and we request that you submit a report. See +L</Reporting Bugs> below. =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. - -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.) - -[ Within each section, list entries as an =item entry ] - -=head2 New Modules and Pragmata - -=over 4 - -=item * - -XXX Remove this section if not applicable. - -=back - =head2 Updated Modules and Pragmata =over 4 @@ -127,146 +28,21 @@ XXX Remove this section if not applicable. L<Module::CoreList> has been upgraded from version 5.20220520 to 5.20230423. -=item * - -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 * - -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 - -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<XXX> - -=over 4 - -=item * - -XXX Description of the change here - -=back - -=head1 Diagnostics - -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 * - -XXX L<message|perldiag/"message"> - -=back - -=head2 Changes to Existing Diagnostics - -XXX Changes (i.e. rewording) of diagnostic messages go here - -=over 4 - -=item * - -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 * - -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 * -C<Configure> probed for the return type of malloc() and free() by -testing whether declarations for those functions produced a function -type mismatch with the implementation. On Solaris, with a C++ -compiler, this check always failed, since Solaris instead imports -malloc() and free() from C<std::> with C<using> for C++ builds. Since -the return types of malloc() and free() are well defined by the C -standard, skip probing for them. C<Configure> command-line arguments -and hints can still override these type in the unlikely case that is -needed. +C<Configure> probed for the return type of malloc() and free() by testing +whether declarations for those functions produced a function type mismatch with +the implementation. On Solaris, with a C++ compiler, this check always failed, +since Solaris instead imports malloc() and free() from C<std::> with C<using> +for C++ builds. Since the return types of malloc() and free() are well defined +by the C standard, skip probing for them. C<Configure> command-line arguments +and hints can still override these type in the unlikely case that is needed. [L<GH #20806|https://github.com/Perl/perl5/issues/20806>] @@ -274,105 +50,11 @@ needed. =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 - -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 XXX-some-platform - -XXX - -=back - -=head2 Discontinued Platforms - -XXX List any platforms that this version of perl no longer compiles on. - -=over 4 - -=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. - -=over 4 - -=item XXX-some-platform - -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 an =item entry ] - -=over 4 - -=item * - -XXX - -=back +Tests were added and changed to reflect the other additions and changes in this +release. =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 * @@ -386,54 +68,21 @@ interpreter panic; e.g. =item * -An C<eval EXPR> referring to a lexical sub defined in grandparent -scope no longer produces an assertion failues. +An C<eval EXPR> referring to a lexical sub defined in grandparent scope no +longer produces an assertion failues. [L<GH #19857|https://github.com/Perl/perl5/issues/19857>] =item * -Writing to a magic variables associated with the selected output -handle, C<$^>, C<$~>, C<$=>, C<$-> and C<$%>, no longer crashes perl -if the IO object has been cleared from the selected output -handle. +Writing to a magic variables associated with the selected output handle, C<$^>, +C<$~>, C<$=>, C<$-> and C<$%>, no longer crashes perl if the IO object has been +cleared from the selected output handle. [L<GH #20733|https://github.com/Perl/perl5/issues/20733>] =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 * - -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. - -=back - -=head1 Obituary - -XXX If any significant core contributor or member of the CPAN community has -died, add a short obituary here. - =head1 Acknowledgements XXX Generate this with: @@ -442,8 +91,8 @@ XXX Generate this with: =head1 Reporting Bugs -If you find what you think is a bug, you might check the perl bug database -at L<https://github.com/Perl/perl5/issues>. There may also be information at +If you find what you think is a bug, you might check the perl bug database at +L<https://github.com/Perl/perl5/issues>. There may also be information at L<http://www.perl.org/>, the Perl Home Page. If you believe you have an unreported bug, please open an issue at @@ -452,13 +101,13 @@ tiny but sufficient test case. If the bug you are reporting has security implications which make it inappropriate to send to a public issue tracker, then see -L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION> -for details of how to report the issue. +L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION> for details of how to +report the issue. =head1 Give Thanks -If you wish to thank the Perl 5 Porters for the work we had done in Perl 5, -you can do so by running the C<perlthanks> program: +If you wish to thank the Perl 5 Porters for the work we had done in Perl 5, you +can do so by running the C<perlthanks> program: perlthanks |