Commit fbba5d11 authored by Rich Salz's avatar Rich Salz
Browse files

Nit about pod filenames 



The asdf.pod filename must have asdf in its NAME section.
also check for names existing as a different filename (via Levitte)

Reviewed-by: default avatarRichard Levitte <levitte@openssl.org>
Reviewed-by: default avatarViktor Dukhovni <viktor@openssl.org>
parent a9da4815

util/find-doc-nits.pl

+14 −0
Original line number Diff line number Diff line
@@ -48,10 +48,24 @@ sub name_synopsis() 
    $tmp =~ tr/\n/ /;

    $tmp =~ s/-.*//g;

    $tmp =~ s/,//g;



    my $dirname = dirname($filename);

    my $simplename = basename($filename);

    $simplename =~ s/.pod$//;

    my $foundfilename = 0;

    my %foundfilenames = ();

    my %names;

    foreach my $n ( split ' ', $tmp ) {

        $names{$n} = 1;

        $foundfilename++ if $n eq $simplename;

        $foundfilenames{$n} = 1

            if -f "$dirname/$n.pod" && $n ne $simplename;

    }

    print "$id the following exist as other .pod files:\n",

        join(" ", sort keys %foundfilenames), "\n"

        if %foundfilenames;

    print "$id $simplename (filename) missing from NAME section\n",

        unless $foundfilename;



    # Find all functions in SYNOPSIS

    return unless $contents =~ /=head1 SYNOPSIS(.*)=head1 DESCRIPTION/ms;