Consistent formatting of flags with args
authorRich Salz <rsalz@akamai.com>
Wed, 25 Sep 2019 19:20:11 +0000 (15:20 -0400)
committerRichard Levitte <levitte@openssl.org>
Tue, 1 Oct 2019 06:36:58 +0000 (08:36 +0200)
commite8769719c9bbe53d7af088111b7625671660d4db
tree222b64baed23d8f70f19928e58486851e5b7fc95
parent4dcb150ea30f9bbfa7946e6b39c30a86aca5ed02
Consistent formatting of flags with args

For documentation of all commands with "-flag arg" format them
consistently: "B<-flag> I<arg>", except when arg is literal
(for example "B<-inform> B<PEM>|B<DER>")
Update find-doc-nits to complain if badly formatted strings are found.

Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10022)
54 files changed:
doc/man1/CA.pl.pod
doc/man1/openssl-asn1parse.pod
doc/man1/openssl-ca.pod
doc/man1/openssl-ciphers.pod
doc/man1/openssl-cms.pod
doc/man1/openssl-crl.pod
doc/man1/openssl-crl2pkcs7.pod
doc/man1/openssl-dgst.pod
doc/man1/openssl-dhparam.pod
doc/man1/openssl-dsa.pod
doc/man1/openssl-dsaparam.pod
doc/man1/openssl-ec.pod
doc/man1/openssl-ecparam.pod
doc/man1/openssl-enc.pod
doc/man1/openssl-fipsinstall.pod
doc/man1/openssl-gendsa.pod
doc/man1/openssl-genpkey.pod
doc/man1/openssl-genrsa.pod
doc/man1/openssl-kdf.pod
doc/man1/openssl-mac.pod
doc/man1/openssl-nseq.pod
doc/man1/openssl-ocsp.pod
doc/man1/openssl-passwd.pod
doc/man1/openssl-pkcs12.pod
doc/man1/openssl-pkcs7.pod
doc/man1/openssl-pkcs8.pod
doc/man1/openssl-pkey.pod
doc/man1/openssl-pkeyparam.pod
doc/man1/openssl-pkeyutl.pod
doc/man1/openssl-prime.pod
doc/man1/openssl-rand.pod
doc/man1/openssl-rehash.pod
doc/man1/openssl-req.pod
doc/man1/openssl-rsa.pod
doc/man1/openssl-rsautl.pod
doc/man1/openssl-s_client.pod
doc/man1/openssl-s_server.pod
doc/man1/openssl-s_time.pod
doc/man1/openssl-sess_id.pod
doc/man1/openssl-smime.pod
doc/man1/openssl-speed.pod
doc/man1/openssl-spkac.pod
doc/man1/openssl-srp.pod
doc/man1/openssl-storeutl.pod
doc/man1/openssl-ts.pod
doc/man1/openssl-tsget.pod
doc/man1/openssl-verify.pod
doc/man1/openssl-x509.pod
doc/man3/BIO_ADDR.pod
doc/man3/PKCS7_verify.pod
doc/man3/X509_NAME_print_ex.pod
doc/man5/config.pod
doc/man7/bio.pod
util/find-doc-nits