From 4bbd41f5cf100c72f174c530ef146ca94952a289 Mon Sep 17 00:00:00 2001 From: Aaron Crane Date: Mon, 25 Jun 2018 15:42:33 +0100 Subject: Ensure perlmodlib.pod contains all non-dual-life modules MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- lib/Config/Extensions.pm | 1 + lib/warnings.pm | 1 + 2 files changed, 2 insertions(+) (limited to 'lib') 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 -- cgit v1.2.1