Skip to content

Commit

Permalink
Preparing perldelta
Browse files Browse the repository at this point in the history
  • Loading branch information
xsawyerx committed Apr 20, 2017
1 parent 5c92a63 commit 6e39efc
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 297 deletions.
321 changes: 25 additions & 296 deletions pod/perldelta.pod
Expand Up @@ -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.25.12

=head1 DESCRIPTION
Expand All @@ -15,84 +12,6 @@ release.
If you are upgrading from an earlier release such as 5.25.10, first read
L<perl52511delta>, which describes differences between 5.25.10 and 5.25.11.

=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 inapplicable.

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 a =item entry ]

=over 4

=item *

XXX

=back

=head1 Modules and Pragmata

XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
Expand Down Expand Up @@ -138,49 +57,10 @@ 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

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.

=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
Expand All @@ -190,204 +70,53 @@ and New Warnings
Since C<.> is now removed from C<@INC> by default, C<do> will now trigger
a warning recommending to fix the C<do> statement:

L<do "%s" failed, '.' is no longer in @INC|perldiag/"do "%s" failed, '.'
is no longer in @INC; did you mean do "./%s"?>

=back

=head3 New Warnings

=over 4

=item *

XXX L<message|perldiag/"message">
L<do "%s" failed, '.' is no longer in @INC|perldiag/do "%s" failed, '.' is no longer in @INC; did you mean do ".E<sol>%s"?>

=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<perlbug> 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 a =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<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.

[ List each test improvement as a =item entry ]

=over 4
When a C<require> fails, we now do not provide C<@INC> when the C<require>
is for a file instead of a module.

=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 a =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
When C<@INC> is not scanned for a C<require> call, we no longer display
C<@INC> to avoid confusion.

=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 a =item entry ]

=over 4

=item *

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 a =item entry ]

=over 4

=item *

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 a =item entry ]

=over 4

=item *

XXX

=back

=head1 Errata From Previous Releases

=over 4
=head1 Acknowledgements

=item *
Perl 5.25.12 represents approximately 4 weeks of development since Perl 5.25.11
and contains approximately 1,900 lines of changes across 150 files from 8
authors.

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 690 lines of changes to 73 .pm, .t, .c and .h files.

=back
Perl continues to flourish into its third decade thanks to a vibrant community
of users and developers. The following people are known to have contributed the
improvements that became Perl 5.25.12:

=head1 Obituary
Chris 'BinGOs' Williams, Dagfinn Ilmari Mannsåker, David Mitchell, James E
Keenan, Jarkko Hietaniemi, Karl Williamson, Pali, Sawyer X.

XXX If any significant core contributor has died, we've added a short obituary
here.

=head1 Acknowledgements
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 Generate this with:
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.

perl Porting/acknowledgements.pl v5.25.5..HEAD
For a more complete list of all of Perl's historical contributors, please see
the F<AUTHORS> file in the Perl source distribution.

=head1 Reporting Bugs

Expand Down
2 changes: 1 addition & 1 deletion pod/perldiag.pod
Expand Up @@ -2061,7 +2061,7 @@ define a C<$VERSION>.
(F) You cannot put a repeat count of any kind right after the '/' code.
See L<perlfunc/pack>.

=item do "%s" failed, '.' is no longer in @INC; did you mean do "./%s"?
=item do "%s" failed, '.' is no longer in @INC; did you mean do ".E<sol>%s"?

(D deprecated) Previously C< do "somefile"; > would search the current
directory for the specified file. Since perl v5.26.0, F<.> has been
Expand Down

0 comments on commit 6e39efc

Please sign in to comment.