summaryrefslogtreecommitdiffstats
path: root/util/find-doc-nits
diff options
context:
space:
mode:
authorRich Salz <rsalz@akamai.com>2020-01-16 19:40:52 +0100
committerDr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>2020-01-29 18:42:31 +0100
commit65718c516ec69ff2314d12c7ce57b242ccc3021d (patch)
tree31f951969e00d21b15659576b2dbb92f11cf76f4 /util/find-doc-nits
parentAdd more generated man1 doc files (diff)
downloadopenssl-65718c516ec69ff2314d12c7ce57b242ccc3021d.tar.xz
openssl-65718c516ec69ff2314d12c7ce57b242ccc3021d.zip
Document most missing options
Add cmd-nits make target. Listing options should stop when it hits the "parameters" separator. Add missing .pod.in files to doc/man1/build.info Tweak find-doc-nits to try openssl-XXX before XXX for POD files and change an error messavge to be more useful. Fix the following pages: ca, cms, crl, dgst, enc, engine, errstr, gendsa, genrsa, list, ocsp, passwd, pkcs7, pkcs12, rand, rehash, req, rsautil, s_server, speed, s_time, sess_id, smime, srp, ts, x509. Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/10873)
Diffstat (limited to '')
-rwxr-xr-xutil/find-doc-nits17
1 files changed, 12 insertions, 5 deletions
diff --git a/util/find-doc-nits b/util/find-doc-nits
index 3daf58182f..293f603b79 100755
--- a/util/find-doc-nits
+++ b/util/find-doc-nits
@@ -808,8 +808,14 @@ sub checkflags {
}
next;
}
- next unless /\[B<-([^ >]+)/;
- my $opt = $1;
+ my $opt;
+ if ( /\[B<-([^ >]+)/ ) {
+ $opt = $1;
+ } elsif ( /^B<-([^ >]+)/ ) {
+ $opt = $1;
+ } else {
+ next;
+ }
$opt = $1 if $opt =~ /I<(.*)/;
$docopts{$1} = 1;
}
@@ -826,7 +832,7 @@ sub checkflags {
my @unimpl = sort grep { !defined $cmdopts{$_} } keys %docopts;
foreach ( @unimpl ) {
next if defined $skips{$_} || defined $localskips{$_};
- err("$cmd documented but not implemented -$_");
+ err("$doc: $cmd does not implement -$_");
}
}
@@ -852,8 +858,9 @@ if ( $opt_c ) {
# See if each has a manpage.
foreach my $cmd ( @commands ) {
next if $cmd eq 'help' || $cmd eq 'exit';
- my $doc = "doc/man1/$cmd.pod";
- $doc = "doc/man1/openssl-$cmd.pod" if -f "doc/man1/openssl-$cmd.pod";
+ my $doc = "doc/man1/openssl-$cmd.pod";
+ # Handle "tsget" and "CA.pl" pod pages
+ $doc = "doc/man1/$cmd.pod" if -f "doc/man1/$cmd.pod";
if ( ! -f "$doc" ) {
err("$doc does not exist");
} else {