From 5e98904c231f5a40c6ce291df85799cca7c8d125 Mon Sep 17 00:00:00 2001 From: Pauli Date: Thu, 27 Feb 2020 07:45:31 +1000 Subject: [PATCH] man1: make all openssl command line tool documentation generated. With the introduction of provider command line options which are applicable to almost all of the command line tools, it seemed reasonable to make them all generated. This simplifes the .gitignore and avoids having to keep two lists in sync. Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/11167) --- .gitignore | 38 +-------- doc/man1/build.info | 82 +++++++++++++++---- ...asn1parse.pod => openssl-asn1parse.pod.in} | 1 + ...ssl-ciphers.pod => openssl-ciphers.pod.in} | 1 + .../{openssl-cmds.pod => openssl-cmds.pod.in} | 1 + ...crl2pkcs7.pod => openssl-crl2pkcs7.pod.in} | 1 + ...enssl-engine.pod => openssl-engine.pod.in} | 1 + ...enssl-errstr.pod => openssl-errstr.pod.in} | 1 + ...install.pod => openssl-fipsinstall.pod.in} | 1 + .../{openssl-info.pod => openssl-info.pod.in} | 1 + .../{openssl-kdf.pod => openssl-kdf.pod.in} | 1 + .../{openssl-list.pod => openssl-list.pod.in} | 1 + .../{openssl-mac.pod => openssl-mac.pod.in} | 1 + .../{openssl-nseq.pod => openssl-nseq.pod.in} | 1 + ...openssl-prime.pod => openssl-prime.pod.in} | 1 + ...l-provider.pod => openssl-provider.pod.in} | 1 + ...enssl-rehash.pod => openssl-rehash.pod.in} | 1 + ...ssl-sess_id.pod => openssl-sess_id.pod.in} | 1 + ...ssl-version.pod => openssl-version.pod.in} | 1 + 19 files changed, 84 insertions(+), 53 deletions(-) rename doc/man1/{openssl-asn1parse.pod => openssl-asn1parse.pod.in} (99%) rename doc/man1/{openssl-ciphers.pod => openssl-ciphers.pod.in} (99%) rename doc/man1/{openssl-cmds.pod => openssl-cmds.pod.in} (98%) rename doc/man1/{openssl-crl2pkcs7.pod => openssl-crl2pkcs7.pod.in} (98%) rename doc/man1/{openssl-engine.pod => openssl-engine.pod.in} (98%) rename doc/man1/{openssl-errstr.pod => openssl-errstr.pod.in} (95%) rename doc/man1/{openssl-fipsinstall.pod => openssl-fipsinstall.pod.in} (98%) rename doc/man1/{openssl-info.pod => openssl-info.pod.in} (97%) rename doc/man1/{openssl-kdf.pod => openssl-kdf.pod.in} (98%) rename doc/man1/{openssl-list.pod => openssl-list.pod.in} (98%) rename doc/man1/{openssl-mac.pod => openssl-mac.pod.in} (98%) rename doc/man1/{openssl-nseq.pod => openssl-nseq.pod.in} (97%) rename doc/man1/{openssl-prime.pod => openssl-prime.pod.in} (95%) rename doc/man1/{openssl-provider.pod => openssl-provider.pod.in} (95%) rename doc/man1/{openssl-rehash.pod => openssl-rehash.pod.in} (98%) rename doc/man1/{openssl-sess_id.pod => openssl-sess_id.pod.in} (98%) rename doc/man1/{openssl-version.pod => openssl-version.pod.in} (96%) diff --git a/.gitignore b/.gitignore index f51ccce56d..0578fd5c1b 100644 --- a/.gitignore +++ b/.gitignore @@ -26,43 +26,7 @@ /include/openssl/opensslv.h # Auto generated doc files -# Keep this in sync with doc/man1/build.info -doc/man1/openssl-ca.pod -doc/man1/openssl-cms.pod -doc/man1/openssl-crl.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-gendsa.pod -doc/man1/openssl-genpkey.pod -doc/man1/openssl-genrsa.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-rand.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-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-verify.pod -doc/man1/openssl-x509.pod +doc/man1/openssl-*.pod # error code files /crypto/err/openssl.txt.old diff --git a/doc/man1/build.info b/doc/man1/build.info index 13012d4432..c48ff0acbe 100644 --- a/doc/man1/build.info +++ b/doc/man1/build.info @@ -1,113 +1,163 @@ -# Keep this in sync with .gitignore! DEPEND[]= \ + openssl-asn1parse.pod \ openssl-ca.pod \ + openssl-ciphers.pod \ + openssl-cmds.pod \ openssl-cms.pod \ + openssl-crl2pkcs7.pod \ openssl-crl.pod \ openssl-dgst.pod \ openssl-dhparam.pod \ - openssl-dsa.pod \ openssl-dsaparam.pod \ - openssl-ec.pod \ + openssl-dsa.pod \ openssl-ecparam.pod \ + openssl-ec.pod \ openssl-enc.pod \ + openssl-engine.pod \ + openssl-errstr.pod \ + openssl-fipsinstall.pod \ openssl-gendsa.pod \ openssl-genpkey.pod \ openssl-genrsa.pod \ + openssl-info.pod \ + openssl-kdf.pod \ + openssl-list.pod \ + openssl-mac.pod \ + openssl-nseq.pod \ openssl-ocsp.pod \ openssl-passwd.pod \ openssl-pkcs12.pod \ openssl-pkcs7.pod \ openssl-pkcs8.pod \ - openssl-pkey.pod \ openssl-pkeyparam.pod \ + openssl-pkey.pod \ openssl-pkeyutl.pod \ + openssl-prime.pod \ + openssl-provider.pod \ openssl-rand.pod \ + openssl-rehash.pod \ openssl-req.pod \ openssl-rsa.pod \ openssl-rsautl.pod \ openssl-s_client.pod \ - openssl-s_server.pod \ - openssl-s_time.pod \ + openssl-sess_id.pod \ openssl-smime.pod \ openssl-speed.pod \ openssl-spkac.pod \ openssl-srp.pod \ + openssl-s_server.pod \ + openssl-s_time.pod \ openssl-storeutl.pod \ openssl-ts.pod \ openssl-verify.pod \ + openssl-version.pod \ openssl-x509.pod +DEPEND[openssl-asn1parse.pod]=../perlvars.pm DEPEND[openssl-ca.pod]=../perlvars.pm +DEPEND[openssl-ciphers.pod]=../perlvars.pm +DEPEND[openssl-cmds.pod]=../perlvars.pm DEPEND[openssl-cms.pod]=../perlvars.pm +DEPEND[openssl-crl2pkcs7.pod]=../perlvars.pm DEPEND[openssl-crl.pod]=../perlvars.pm DEPEND[openssl-dgst.pod]=../perlvars.pm DEPEND[openssl-dhparam.pod]=../perlvars.pm -DEPEND[openssl-dsa.pod]=../perlvars.pm DEPEND[openssl-dsaparam.pod]=../perlvars.pm -DEPEND[openssl-ec.pod]=../perlvars.pm +DEPEND[openssl-dsa.pod]=../perlvars.pm DEPEND[openssl-ecparam.pod]=../perlvars.pm +DEPEND[openssl-ec.pod]=../perlvars.pm DEPEND[openssl-enc.pod]=../perlvars.pm +DEPEND[openssl-engine.pod]=../perlvars.pm +DEPEND[openssl-errstr.pod]=../perlvars.pm +DEPEND[openssl-fipsinstall.pod]=../perlvars.pm DEPEND[openssl-gendsa.pod]=../perlvars.pm DEPEND[openssl-genpkey.pod]=../perlvars.pm DEPEND[openssl-genrsa.pod]=../perlvars.pm +DEPEND[openssl-info.pod]=../perlvars.pm +DEPEND[openssl-kdf.pod]=../perlvars.pm +DEPEND[openssl-list.pod]=../perlvars.pm +DEPEND[openssl-mac.pod]=../perlvars.pm +DEPEND[openssl-nseq.pod]=../perlvars.pm DEPEND[openssl-ocsp.pod]=../perlvars.pm DEPEND[openssl-passwd.pod]=../perlvars.pm DEPEND[openssl-pkcs12.pod]=../perlvars.pm DEPEND[openssl-pkcs7.pod]=../perlvars.pm DEPEND[openssl-pkcs8.pod]=../perlvars.pm -DEPEND[openssl-pkey.pod]=../perlvars.pm DEPEND[openssl-pkeyparam.pod]=../perlvars.pm +DEPEND[openssl-pkey.pod]=../perlvars.pm DEPEND[openssl-pkeyutl.pod]=../perlvars.pm +DEPEND[openssl-prime.pod]=../perlvars.pm +DEPEND[openssl-provider.pod]=../perlvars.pm DEPEND[openssl-rand.pod]=../perlvars.pm +DEPEND[openssl-rehash.pod]=../perlvars.pm DEPEND[openssl-req.pod]=../perlvars.pm DEPEND[openssl-rsa.pod]=../perlvars.pm DEPEND[openssl-rsautl.pod]=../perlvars.pm DEPEND[openssl-s_client.pod]=../perlvars.pm -DEPEND[openssl-s_server.pod]=../perlvars.pm -DEPEND[openssl-s_time.pod]=../perlvars.pm +DEPEND[openssl-sess_id.pod]=../perlvars.pm DEPEND[openssl-smime.pod]=../perlvars.pm DEPEND[openssl-speed.pod]=../perlvars.pm DEPEND[openssl-spkac.pod]=../perlvars.pm DEPEND[openssl-srp.pod]=../perlvars.pm +DEPEND[openssl-s_server.pod]=../perlvars.pm +DEPEND[openssl-s_time.pod]=../perlvars.pm DEPEND[openssl-storeutl.pod]=../perlvars.pm DEPEND[openssl-ts.pod]=../perlvars.pm DEPEND[openssl-verify.pod]=../perlvars.pm +DEPEND[openssl-version.pod]=../perlvars.pm DEPEND[openssl-x509.pod]=../perlvars.pm +GENERATE[openssl-asn1parse.pod]=openssl-asn1parse.pod.in GENERATE[openssl-ca.pod]=openssl-ca.pod.in +GENERATE[openssl-ciphers.pod]=openssl-ciphers.pod.in +GENERATE[openssl-cmds.pod]=openssl-cmds.pod.in GENERATE[openssl-cms.pod]=openssl-cms.pod.in +GENERATE[openssl-crl2pkcs7.pod]=openssl-crl2pkcs7.pod.in GENERATE[openssl-crl.pod]=openssl-crl.pod.in GENERATE[openssl-dgst.pod]=openssl-dgst.pod.in GENERATE[openssl-dhparam.pod]=openssl-dhparam.pod.in -GENERATE[openssl-dsa.pod]=openssl-dsa.pod.in GENERATE[openssl-dsaparam.pod]=openssl-dsaparam.pod.in -GENERATE[openssl-ec.pod]=openssl-ec.pod.in +GENERATE[openssl-dsa.pod]=openssl-dsa.pod.in GENERATE[openssl-ecparam.pod]=openssl-ecparam.pod.in +GENERATE[openssl-ec.pod]=openssl-ec.pod.in GENERATE[openssl-enc.pod]=openssl-enc.pod.in +GENERATE[openssl-engine.pod]=openssl-engine.pod.in +GENERATE[openssl-errstr.pod]=openssl-errstr.pod.in +GENERATE[openssl-fipsinstall.pod]=openssl-fipsinstall.pod.in GENERATE[openssl-gendsa.pod]=openssl-gendsa.pod.in GENERATE[openssl-genpkey.pod]=openssl-genpkey.pod.in GENERATE[openssl-genrsa.pod]=openssl-genrsa.pod.in +GENERATE[openssl-info.pod]=openssl-info.pod.in +GENERATE[openssl-kdf.pod]=openssl-kdf.pod.in +GENERATE[openssl-list.pod]=openssl-list.pod.in +GENERATE[openssl-mac.pod]=openssl-mac.pod.in +GENERATE[openssl-nseq.pod]=openssl-nseq.pod.in GENERATE[openssl-ocsp.pod]=openssl-ocsp.pod.in GENERATE[openssl-passwd.pod]=openssl-passwd.pod.in GENERATE[openssl-pkcs12.pod]=openssl-pkcs12.pod.in GENERATE[openssl-pkcs7.pod]=openssl-pkcs7.pod.in GENERATE[openssl-pkcs8.pod]=openssl-pkcs8.pod.in -GENERATE[openssl-pkey.pod]=openssl-pkey.pod.in GENERATE[openssl-pkeyparam.pod]=openssl-pkeyparam.pod.in +GENERATE[openssl-pkey.pod]=openssl-pkey.pod.in GENERATE[openssl-pkeyutl.pod]=openssl-pkeyutl.pod.in +GENERATE[openssl-prime.pod]=openssl-prime.pod.in +GENERATE[openssl-provider.pod]=openssl-provider.pod.in GENERATE[openssl-rand.pod]=openssl-rand.pod.in +GENERATE[openssl-rehash.pod]=openssl-rehash.pod.in GENERATE[openssl-req.pod]=openssl-req.pod.in GENERATE[openssl-rsa.pod]=openssl-rsa.pod.in GENERATE[openssl-rsautl.pod]=openssl-rsautl.pod.in GENERATE[openssl-s_client.pod]=openssl-s_client.pod.in -GENERATE[openssl-s_server.pod]=openssl-s_server.pod.in -GENERATE[openssl-s_time.pod]=openssl-s_time.pod.in +GENERATE[openssl-sess_id.pod]=openssl-sess_id.pod.in GENERATE[openssl-smime.pod]=openssl-smime.pod.in GENERATE[openssl-speed.pod]=openssl-speed.pod.in GENERATE[openssl-spkac.pod]=openssl-spkac.pod.in GENERATE[openssl-srp.pod]=openssl-srp.pod.in +GENERATE[openssl-s_server.pod]=openssl-s_server.pod.in +GENERATE[openssl-s_time.pod]=openssl-s_time.pod.in GENERATE[openssl-storeutl.pod]=openssl-storeutl.pod.in GENERATE[openssl-ts.pod]=openssl-ts.pod.in GENERATE[openssl-verify.pod]=openssl-verify.pod.in +GENERATE[openssl-version.pod]=openssl-version.pod.in GENERATE[openssl-x509.pod]=openssl-x509.pod.in diff --git a/doc/man1/openssl-asn1parse.pod b/doc/man1/openssl-asn1parse.pod.in similarity index 99% rename from doc/man1/openssl-asn1parse.pod rename to doc/man1/openssl-asn1parse.pod.in index 698ce47897..9b95966440 100644 --- a/doc/man1/openssl-asn1parse.pod +++ b/doc/man1/openssl-asn1parse.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =head1 NAME diff --git a/doc/man1/openssl-ciphers.pod b/doc/man1/openssl-ciphers.pod.in similarity index 99% rename from doc/man1/openssl-ciphers.pod rename to doc/man1/openssl-ciphers.pod.in index 8ba80ba15d..5997b6d543 100644 --- a/doc/man1/openssl-ciphers.pod +++ b/doc/man1/openssl-ciphers.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =head1 NAME diff --git a/doc/man1/openssl-cmds.pod b/doc/man1/openssl-cmds.pod.in similarity index 98% rename from doc/man1/openssl-cmds.pod rename to doc/man1/openssl-cmds.pod.in index d44d40cfec..50f0bc66e4 100644 --- a/doc/man1/openssl-cmds.pod +++ b/doc/man1/openssl-cmds.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =head1 NAME diff --git a/doc/man1/openssl-crl2pkcs7.pod b/doc/man1/openssl-crl2pkcs7.pod.in similarity index 98% rename from doc/man1/openssl-crl2pkcs7.pod rename to doc/man1/openssl-crl2pkcs7.pod.in index 70662d4e0f..187b6a5856 100644 --- a/doc/man1/openssl-crl2pkcs7.pod +++ b/doc/man1/openssl-crl2pkcs7.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =head1 NAME diff --git a/doc/man1/openssl-engine.pod b/doc/man1/openssl-engine.pod.in similarity index 98% rename from doc/man1/openssl-engine.pod rename to doc/man1/openssl-engine.pod.in index 7110ceecbc..c4b0665376 100644 --- a/doc/man1/openssl-engine.pod +++ b/doc/man1/openssl-engine.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =head1 NAME diff --git a/doc/man1/openssl-errstr.pod b/doc/man1/openssl-errstr.pod.in similarity index 95% rename from doc/man1/openssl-errstr.pod rename to doc/man1/openssl-errstr.pod.in index ea838d9eb2..3a4e5163f9 100644 --- a/doc/man1/openssl-errstr.pod +++ b/doc/man1/openssl-errstr.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =head1 NAME diff --git a/doc/man1/openssl-fipsinstall.pod b/doc/man1/openssl-fipsinstall.pod.in similarity index 98% rename from doc/man1/openssl-fipsinstall.pod rename to doc/man1/openssl-fipsinstall.pod.in index 9c7c856b0d..6ea3fca4d9 100644 --- a/doc/man1/openssl-fipsinstall.pod +++ b/doc/man1/openssl-fipsinstall.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =head1 NAME diff --git a/doc/man1/openssl-info.pod b/doc/man1/openssl-info.pod.in similarity index 97% rename from doc/man1/openssl-info.pod rename to doc/man1/openssl-info.pod.in index 6e16bb809f..c8965b2ab6 100644 --- a/doc/man1/openssl-info.pod +++ b/doc/man1/openssl-info.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =head1 NAME diff --git a/doc/man1/openssl-kdf.pod b/doc/man1/openssl-kdf.pod.in similarity index 98% rename from doc/man1/openssl-kdf.pod rename to doc/man1/openssl-kdf.pod.in index d89f84fd43..5073ac09fc 100644 --- a/doc/man1/openssl-kdf.pod +++ b/doc/man1/openssl-kdf.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =head1 NAME diff --git a/doc/man1/openssl-list.pod b/doc/man1/openssl-list.pod.in similarity index 98% rename from doc/man1/openssl-list.pod rename to doc/man1/openssl-list.pod.in index 88bcc751e6..dc5572e6a3 100644 --- a/doc/man1/openssl-list.pod +++ b/doc/man1/openssl-list.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =head1 NAME diff --git a/doc/man1/openssl-mac.pod b/doc/man1/openssl-mac.pod.in similarity index 98% rename from doc/man1/openssl-mac.pod rename to doc/man1/openssl-mac.pod.in index e5ec76395e..5cc65f6c8d 100644 --- a/doc/man1/openssl-mac.pod +++ b/doc/man1/openssl-mac.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =head1 NAME diff --git a/doc/man1/openssl-nseq.pod b/doc/man1/openssl-nseq.pod.in similarity index 97% rename from doc/man1/openssl-nseq.pod rename to doc/man1/openssl-nseq.pod.in index 5404e1f340..3d29ae878f 100644 --- a/doc/man1/openssl-nseq.pod +++ b/doc/man1/openssl-nseq.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =head1 NAME diff --git a/doc/man1/openssl-prime.pod b/doc/man1/openssl-prime.pod.in similarity index 95% rename from doc/man1/openssl-prime.pod rename to doc/man1/openssl-prime.pod.in index aa9af22102..9aafabe602 100644 --- a/doc/man1/openssl-prime.pod +++ b/doc/man1/openssl-prime.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =head1 NAME diff --git a/doc/man1/openssl-provider.pod b/doc/man1/openssl-provider.pod.in similarity index 95% rename from doc/man1/openssl-provider.pod rename to doc/man1/openssl-provider.pod.in index b29d2f5a26..774f92b9ac 100644 --- a/doc/man1/openssl-provider.pod +++ b/doc/man1/openssl-provider.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =head1 NAME diff --git a/doc/man1/openssl-rehash.pod b/doc/man1/openssl-rehash.pod.in similarity index 98% rename from doc/man1/openssl-rehash.pod rename to doc/man1/openssl-rehash.pod.in index 241f225380..428de47db7 100644 --- a/doc/man1/openssl-rehash.pod +++ b/doc/man1/openssl-rehash.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =for comment Original text by James Westby, contributed under the OpenSSL license. diff --git a/doc/man1/openssl-sess_id.pod b/doc/man1/openssl-sess_id.pod.in similarity index 98% rename from doc/man1/openssl-sess_id.pod rename to doc/man1/openssl-sess_id.pod.in index bb49dbd56b..f68f180739 100644 --- a/doc/man1/openssl-sess_id.pod +++ b/doc/man1/openssl-sess_id.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =head1 NAME diff --git a/doc/man1/openssl-version.pod b/doc/man1/openssl-version.pod.in similarity index 96% rename from doc/man1/openssl-version.pod rename to doc/man1/openssl-version.pod.in index 62d50ce701..d2aaaecbf3 100644 --- a/doc/man1/openssl-version.pod +++ b/doc/man1/openssl-version.pod.in @@ -1,4 +1,5 @@ =pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} =head1 NAME -- 2.25.1