From 65718c516ec69ff2314d12c7ce57b242ccc3021d Mon Sep 17 00:00:00 2001 From: Rich Salz Date: Thu, 16 Jan 2020 13:40:52 -0500 Subject: 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 Reviewed-by: Dmitry Belyavskiy Reviewed-by: Matthias St. Pierre (Merged from https://github.com/openssl/openssl/pull/10873) --- util/find-doc-nits | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) (limited to 'util/find-doc-nits') 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 { -- cgit v1.2.3