diff options
| author | Aaron Crane <arc@cpan.org> | 2018-06-25 15:42:33 +0100 |
|---|---|---|
| committer | Aaron Crane <arc@cpan.org> | 2018-07-22 13:06:55 +0100 |
| commit | 4bbd41f5cf100c72f174c530ef146ca94952a289 (patch) | |
| tree | 9ecb6ee760e68a081a36d579c87c3d653d3f1eed /lib | |
| parent | 2027d3658f4b767823e788e70ad97e67d3aa4ff2 (diff) | |
| download | perl-4bbd41f5cf100c72f174c530ef146ca94952a289.tar.gz | |
Ensure perlmodlib.pod contains all non-dual-life modules
The pod/perlmodlib.pod file is generated at build time by pod/perlmodlib.PL,
which looks at the POD of library and pragma files to find "=head1 NAME"
directives. It reads each file a paragraph at a time ($/ = ""), and considers
each individual paragraph as potentially containing POD.
However, if it finds no "=head1 NAME" entry in a module, it silently ignores
it. That's reasonable for dual-life modules — there's often a good reason
why a particular file has no POD — but for single-life modules, this could
well indicate an issue.
In particular, commit effd17dc012719d584aa712c6c7bd5dc142885b6, as part of
rearranging the contents of lib/warnings.pm, inadvertently changed the
context of its "=head1 NAME" line so that it's no longer the start of a
paragraph. This had the effect of removing warnings.pm from perlmodlib; that
gap was pointed out by pink_mist++ on IRC.
The fix for that is trivial: add a blank in the appropriate place in
regen/warnings.pl, and regen.
The change to pod/perlmodlib.PL to die on missing "=head1 NAME" lines has
also yielded a second module (Config::Extensions) that was missing from
perlmodlib for the same reason; that's also fixed in this commit.
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/Config/Extensions.pm | 1 | ||||
| -rw-r--r-- | lib/warnings.pm | 1 |
2 files changed, 2 insertions, 0 deletions
diff --git a/lib/Config/Extensions.pm b/lib/Config/Extensions.pm index 5c241e97ae..a0809ccf3e 100644 --- a/lib/Config/Extensions.pm +++ b/lib/Config/Extensions.pm @@ -17,6 +17,7 @@ foreach my $type (qw(static dynamic nonxs)) { 1; __END__ + =head1 NAME Config::Extensions - hash lookup of which core extensions were built. diff --git a/lib/warnings.pm b/lib/warnings.pm index 43d3925936..3c9ce335d6 100644 --- a/lib/warnings.pm +++ b/lib/warnings.pm @@ -544,6 +544,7 @@ delete @warnings::{qw(NORMAL FATAL MESSAGE LEVEL)}; 1; __END__ + =head1 NAME warnings - Perl pragma to control optional warnings |