diff options
| author | Richard Levitte <levitte@openssl.org> | 2019-05-05 11:30:38 +0200 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2019-05-12 13:43:38 -0700 |
| commit | 1f79ddf5049ff53ad8a7cbab76e62d02d9ac099f (patch) | |
| tree | d8285369c0a34ebcdab7c2dcb0e8aab34b8b7eb2 /util/find-doc-nits | |
| parent | 2e49c05472ab76cee4e30c2eaa4fa576b9ae92c6 (diff) | |
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: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/8878)
Diffstat (limited to 'util/find-doc-nits')
| -rwxr-xr-x | util/find-doc-nits | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/util/find-doc-nits b/util/find-doc-nits index 66966eb355..25f3d5e2c8 100755 --- a/util/find-doc-nits +++ b/util/find-doc-nits @@ -66,6 +66,7 @@ sub name_synopsis() $tmp =~ tr/\n/ /; print "$id trailing comma before - in NAME\n" if $tmp =~ /, *-/; $tmp =~ s/ -.*//g; + print "$id POD markup among the names in NAME\n" if $tmp =~ /[<>]/; $tmp =~ s/ */ /g; print "$id missing comma in NAME\n" if $tmp =~ /[^,] /; @@ -198,8 +199,6 @@ sub check() if $contents =~ /=head\d\s\s+/; print "$id period in NAME section\n" 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" if $contents =~ /L<([^>]*)\|([^>]*)>/ && $1 eq $2; print "$id Bad =over $1\n" |