From 0deccbc48080cbdd305d6c0c62702b49ee113ecc Mon Sep 17 00:00:00 2001 From: Abigail Date: Sun, 16 Dec 2018 00:27:51 +0100 Subject: Get pod/perldelta in shape. * Fixed POD issues. * Fixed spelling. * Removed most of the templating stuff; only the Module List and Acknowledgment are left -- they will be done at the day of the release. --- pod/perldelta.pod | 247 +++--------------------------------------------------- 1 file changed, 10 insertions(+), 237 deletions(-) diff --git a/pod/perldelta.pod b/pod/perldelta.pod index 62b241af0b..564cc1a980 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.29.6 =head1 DESCRIPTION @@ -15,18 +12,6 @@ release. If you are upgrading from an earlier release such as 5.29.4, first read L, which describes differences between 5.29.4 and 5.29.5. -=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 section. - -[ List each enhancement as a =head2 entry ] - =head1 Security =head2 [CVE-2018-18312] Heap-buffer-overflow write in S_regatom (regcomp.c) @@ -36,59 +21,8 @@ compilation, potentially allowing arbitrary code execution. L<[perl #133423]|https://rt.perl.org/Ticket/Display.html?id=133423> - -[ 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 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 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 * @@ -179,34 +113,23 @@ XXX =head1 Documentation -XXX Changes to files in F go here. Consider grouping entries by -file and be sure to link to the appropriate page, e.g. L. - -=head2 New Documentation - -XXX Changes which create B files in F go here. - -=head3 L - -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, send email to L. -XXX Changes which significantly change existing files in F go here. -However, any changes to F should go in the L -section. - Additionally, the following selected changes have been made: =head3 L =over 4 -Clearification of behaviour of C. +=item * + +Clarification of behaviour of C. + +=back =head3 L @@ -214,12 +137,14 @@ Clearification of behaviour of C. =item * -Clearification of the syntax of /(?(cond)yes)/. +Clarification of the syntax of /(?(cond)yes)/. =back =head3 L +=over + =item * We no longer have null (empty line) here doc terminators, so @@ -233,38 +158,8 @@ 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. -XXX New or changed warnings emitted by the core's C code go here. Also -include any changes in L that reconcile it to the 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 - -=back - -=head3 New Warnings - -=over 4 - -=item * - -XXX L - -=back - =head2 Changes to Existing Diagnostics -XXX Changes (i.e. rewording) of diagnostic messages go here - =over 4 =item * @@ -278,13 +173,6 @@ as that spelling has been around the longest. =head1 Utility Changes -XXX Changes to installed programs such as F and F go here. -Most of these are built within the directory F. - -[ List utility changes as a =head2 entry for each utility and =item -entries for each change -Use L with program names to get proper documentation linking. ] - =head2 L =over 4 @@ -296,97 +184,27 @@ C<< OUTLIST >> parameters, but these aren't arguments to the perl function. This has been rectified. L<[perl #133654]|https://rt.perl.org/Ticket/Display.html?id=133654>. - -=back - -=head1 Configuration and Compilation - -XXX Changes to F, F, F, 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 section, instead. - -[ List changes as an =item entry ]. - -=over 4 - -=item * - -XXX - =back =head1 Testing -XXX Any significant changes to the testing of a freshly built perl should be -listed here. Changes which create B files in F go here as do any -large changes to the testing harness (e.g. when parallel testing was added). -Changes to existing files in F 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 * -Some tests in C<< t/io/eintr.t >> caused the process to hang on +Some tests in F<< t/io/eintr.t >> caused the process to hang on pre-16 Darwin. These tests are skipped for those version of Darwin. =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 -directories, or new subdirectories and F 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 section. - =over 4 =item Cygwin @@ -401,12 +219,6 @@ C99 math functions are now available. =head1 Internal Changes -XXX Changes which affect the interface available to C 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 * @@ -417,7 +229,6 @@ except that they contain a code point which requires UTF-8 to represent/match. Hence, if the target string isn't UTF-8, we know it can't possibly match, without needing to try. - =item * C<< print_bytes_for_locale() >> is now defined if C<< DEBUGGING >>, @@ -428,11 +239,6 @@ on the platform. =head1 Selected Bug Fixes -XXX Important bug fixes in the core language are summarized here. Bug fixes in -files in F and F are best summarized in L. - -[ List each fix as an =item entry ] - =over 4 =item * @@ -467,7 +273,7 @@ L<[perl #133696]|https://rt.perl.org/Ticket/Display.html?id=133696>. =item * -Prevent the tests L<< ext/B/t/strict.t >> from being skipped. +Prevent the tests in F<< ext/B/t/strict.t >> from being skipped. L<[perl #133713]|https://rt.perl.org/Ticket/Display.html?id=133713>. =item * @@ -480,39 +286,6 @@ under C<< /ui >> and C<< /di >>. =back - -=head1 Known Problems - -XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any -tests that had to be Ced 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: -- cgit v1.2.1