diff options
| author | Rich Salz <rsalz@akamai.com> | 2020-02-18 11:52:12 -0500 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2020-03-11 06:17:17 +0100 |
| commit | 4b5371913ed9bb4bfd8a55a30458932799296ab9 (patch) | |
| tree | 38500c81cc9c727c25aba0fadc2b5ad982871808 /util/find-doc-nits | |
| parent | 44387c9000197b219e7673d5522517a1a6499af8 (diff) | |
| download | openssl-4b5371913ed9bb4bfd8a55a30458932799296ab9.zip openssl-4b5371913ed9bb4bfd8a55a30458932799296ab9.tar.gz openssl-4b5371913ed9bb4bfd8a55a30458932799296ab9.tar.bz2 | |
DOCS: Use "command" not "tool" or "utility"
Reviewed-by: Paul Yang <kaishen.yy@antfin.com>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/11123)
Diffstat (limited to 'util/find-doc-nits')
| -rwxr-xr-x | util/find-doc-nits | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/util/find-doc-nits b/util/find-doc-nits index f02edab..c508e24 100755 --- a/util/find-doc-nits +++ b/util/find-doc-nits @@ -601,6 +601,13 @@ sub wording { } err($id, "found 'epoch' should use 'Epoch'") if $contents =~ /\bepoch\b/; + if ( $id =~ m@man1/@ ) { + err($id, "found 'tool' in NAME, should use 'command'") + if $contents =~ /=head1 NAME.*\btool\b.*=head1 SYNOPSIS/s; + err($id, "found 'utility' in NAME, should use 'command'") + if $contents =~ /NAME.*\butility\b.*=head1 SYNOPSIS/s; + + } } # Perform all sorts of nit/error checks on a manpage |