diff options
| author | Karl Williamson <khw@cpan.org> | 2022-05-02 13:54:27 -0600 |
|---|---|---|
| committer | Karl Williamson <khw@cpan.org> | 2022-05-02 14:10:23 -0600 |
| commit | e10306bf3bae26c846250219f855d46b17c65b28 (patch) | |
| tree | a69855445bda530f44961d0f898981a16436de93 /autodoc.pl | |
| parent | c8b3b0eeca13e71b324433abc72356383fe0c1ad (diff) | |
| download | perl-e10306bf3bae26c846250219f855d46b17c65b28.tar.gz | |
autodoc.pl: A source is perlxs.pod
This was meant to be looked at, but wasn't. It's skipping cpan, dist,
and ext, which it really should be, because we don't have much control
over those.
The comments indicated it expected to get generated files from
lib/ instead, but those wouldn't be in MANIFEST, so weren't getting
looked at. And it's not a good idea to look for them anyway, as one
could get relicts. Instead create an exception list of pods that could
have API elements that are documented.
The only current file on that list is what becomes lib/perlxs.pod
Diffstat (limited to 'autodoc.pl')
| -rw-r--r-- | autodoc.pl | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/autodoc.pl b/autodoc.pl index e65e36d5c8..6575df098f 100644 --- a/autodoc.pl +++ b/autodoc.pl @@ -11,7 +11,10 @@ use Text::Tabs; # # embed.fnc # plus all the core .c, .h, and .pod files listed in MANIFEST -# +# plus %extra_input_pods + +my %extra_input_pods = ( 'dist/ExtUtils-ParseXS/lib/perlxs.pod' => 1 ); + # Has an optional arg, which is the directory to chdir to before reading # MANIFEST and the files # @@ -1673,9 +1676,9 @@ open my $fh, '<', 'MANIFEST' while (my $line = <$fh>) { next unless my ($file) = $line =~ /^(\S+\.(?:[ch]|pod))\t/; - # Don't pick up pods from these. (We may pick up generated stuff from - # /lib though) - next if $file =~ m! ^ ( cpan | dist | ext ) / !x; + # Don't pick up pods from these. + next if $file =~ m! ^ ( cpan | dist | ext ) / !x + && ! defined $extra_input_pods{$file}; open F, '<', $file or die "Cannot open $file for docs: $!\n"; autodoc(\*F,$file); @@ -1702,7 +1705,7 @@ my @missing_api = grep $funcflags{$_}{flags} =~ /A/ && !$docs{api}{$_}, keys %funcflags; push @missing_api, keys %missing_macros; -my @other_places = ( qw(perlclib perlxs), keys %described_elsewhere ); +my @other_places = ( qw(perlclib ), keys %described_elsewhere ); my $places_other_than_intern = join ", ", map { "L<$_>" } sort dictionary_order 'perlapi', @other_places; my $places_other_than_api = join ", ", |