Browse Source

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 <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/11167)
Pauli 4 years ago
parent
commit
5e98904c23

+ 1 - 37
.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

+ 66 - 16
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

+ 1 - 0
doc/man1/openssl-asn1parse.pod → doc/man1/openssl-asn1parse.pod.in

@@ -1,4 +1,5 @@
 =pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
 
 =head1 NAME
 

+ 1 - 0
doc/man1/openssl-ciphers.pod → doc/man1/openssl-ciphers.pod.in

@@ -1,4 +1,5 @@
 =pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
 
 =head1 NAME
 

+ 1 - 0
doc/man1/openssl-cmds.pod → doc/man1/openssl-cmds.pod.in

@@ -1,4 +1,5 @@
 =pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
 
 =head1 NAME
 

+ 1 - 0
doc/man1/openssl-crl2pkcs7.pod → doc/man1/openssl-crl2pkcs7.pod.in

@@ -1,4 +1,5 @@
 =pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
 
 =head1 NAME
 

+ 1 - 0
doc/man1/openssl-engine.pod → doc/man1/openssl-engine.pod.in

@@ -1,4 +1,5 @@
 =pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
 
 =head1 NAME
 

+ 1 - 0
doc/man1/openssl-errstr.pod → doc/man1/openssl-errstr.pod.in

@@ -1,4 +1,5 @@
 =pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
 
 =head1 NAME
 

+ 1 - 0
doc/man1/openssl-fipsinstall.pod → doc/man1/openssl-fipsinstall.pod.in

@@ -1,4 +1,5 @@
 =pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
 
 =head1 NAME
 

+ 1 - 0
doc/man1/openssl-info.pod → doc/man1/openssl-info.pod.in

@@ -1,4 +1,5 @@
 =pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
 
 =head1 NAME
 

+ 1 - 0
doc/man1/openssl-kdf.pod → doc/man1/openssl-kdf.pod.in

@@ -1,4 +1,5 @@
 =pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
 
 =head1 NAME
 

+ 1 - 0
doc/man1/openssl-list.pod → doc/man1/openssl-list.pod.in

@@ -1,4 +1,5 @@
 =pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
 
 =head1 NAME
 

+ 1 - 0
doc/man1/openssl-mac.pod → doc/man1/openssl-mac.pod.in

@@ -1,4 +1,5 @@
 =pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
 
 =head1 NAME
 

+ 1 - 0
doc/man1/openssl-nseq.pod → doc/man1/openssl-nseq.pod.in

@@ -1,4 +1,5 @@
 =pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
 
 =head1 NAME
 

+ 1 - 0
doc/man1/openssl-prime.pod → doc/man1/openssl-prime.pod.in

@@ -1,4 +1,5 @@
 =pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
 
 =head1 NAME
 

+ 1 - 0
doc/man1/openssl-provider.pod → doc/man1/openssl-provider.pod.in

@@ -1,4 +1,5 @@
 =pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
 
 =head1 NAME
 

+ 1 - 0
doc/man1/openssl-rehash.pod → 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.

+ 1 - 0
doc/man1/openssl-sess_id.pod → doc/man1/openssl-sess_id.pod.in

@@ -1,4 +1,5 @@
 =pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
 
 =head1 NAME
 

+ 1 - 0
doc/man1/openssl-version.pod → doc/man1/openssl-version.pod.in

@@ -1,4 +1,5 @@
 =pod
+{- OpenSSL::safe::output_do_not_edit_headers(); -}
 
 =head1 NAME