Commit 1f79ddf5 authored by Richard Levitte's avatar Richard Levitte
Browse files

util/find-doc-nits: Fine tune detection of POD markup in NAME section 



POD markup is only forbidden in the actual names, while permitted in
the description.

Reviewed-by: default avatarPaul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/8878)
parent 2e49c054

util/find-doc-nits

+1 −2
Original line number Original line Diff line number Diff line
@@ -66,6 +66,7 @@ sub name_synopsis() 
    $tmp =~ tr/\n/ /;

    $tmp =~ tr/\n/ /;

    print "$id trailing comma before - in NAME\n" if $tmp =~ /, *-/;

    print "$id trailing comma before - in NAME\n" if $tmp =~ /, *-/;

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

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

    print "$id POD markup among the names in NAME\n" if $tmp =~ /[<>]/;

    $tmp =~ s/  */ /g;

    $tmp =~ s/  */ /g;

    print "$id missing comma in NAME\n" if $tmp =~ /[^,] /;

    print "$id missing comma in NAME\n" if $tmp =~ /[^,] /;
@@ -198,8 +199,6 @@ sub check() 
        if $contents =~ /=head\d\s\s+/;

        if $contents =~ /=head\d\s\s+/;

    print "$id period in NAME section\n"

    print "$id period in NAME section\n"

        if $contents =~ /=head1 NAME.*\.\n.*=head1 SYNOPSIS/ms;

        if $contents =~ /=head1 NAME.*\.\n.*=head1 SYNOPSIS/ms;

    print "$id POD markup in NAME section\n"

        if $contents =~ /=head1 NAME.*[<>].*=head1 SYNOPSIS/ms;

    print "$id Duplicate $1 in L<>\n"

    print "$id Duplicate $1 in L<>\n"

        if $contents =~ /L<([^>]*)\|([^>]*)>/ && $1 eq $2;

        if $contents =~ /L<([^>]*)\|([^>]*)>/ && $1 eq $2;

    print "$id Bad =over $1\n"

    print "$id Bad =over $1\n"