From: Rich Salz Date: Sat, 12 Oct 2019 21:45:56 +0000 (-0400) Subject: Infrastructure for templated doc in POD files X-Git-Tag: openssl-3.0.0-alpha1~1058 X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=9fcb9702fba8aa135945f96aefddf050a6f4f11d;p=oweals%2Fopenssl.git Infrastructure for templated doc in POD files Use new doc-build capabilities Add -i flag to dofile. Add doc/man1 to SUBDIRS for the new templated doc files Rewrite commit a397aca (merged from PR 10118) to use the doc-template stuff. Put template references in common place Template options and text come at the end of command-specific options: opt_x, opt_trust, opt_r (in that order). Refactor xchain options. Do doc-nits after building generated sources. Reviewed-by: Tomas Mraz Reviewed-by: Richard Levitte (Merged from https://github.com/openssl/openssl/pull/10159) --- diff --git a/.gitignore b/.gitignore index f035ab1975..fa57dfcb38 100644 --- a/.gitignore +++ b/.gitignore @@ -25,6 +25,35 @@ /include/openssl/opensslconf.h /include/openssl/opensslv.h +# Auto generated doc files +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-dsaparam.pod +doc/man1/openssl-ecparam.pod +doc/man1/openssl-enc.pod +doc/man1/openssl-gendsa.pod +doc/man1/openssl-genrsa.pod +doc/man1/openssl-ocsp.pod +doc/man1/openssl-passwd.pod +doc/man1/openssl-pkcs12.pod +doc/man1/openssl-pkcs8.pod +doc/man1/openssl-pkeyutl.pod +doc/man1/openssl-rand.pod +doc/man1/openssl-req.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-srp.pod +doc/man1/openssl-ts.pod +doc/man1/openssl-verify.pod +doc/man1/openssl-x509.pod + # error code files /crypto/err/openssl.txt.old /engines/e_afalg.txt.old diff --git a/.travis.yml b/.travis.yml index 9f616c7e00..4b104642ff 100644 --- a/.travis.yml +++ b/.travis.yml @@ -177,14 +177,14 @@ script: echo -e '\052\052 FAILED -- UPDATED FILES NOT COMMITED'; travis_terminate 1; fi - - if test -n "$CHECKDOCS" && ! $make doc-nits; then - echo -e '\052\052 FAILED -- MAKE DOC-NITS'; - travis_terminate 1; - fi - if test -n "$GENERATE" && ! $make build_all_generated; then echo -e '\052\052 FAILED -- MAKE BUILD_ALL_GENERATED'; travis_terminate 1; fi + - if test -n "$CHECKDOCS" && ! $make doc-nits; then + echo -e '\052\052 FAILED -- MAKE DOC-NITS'; + travis_terminate 1; + fi - if ! $make2; then echo -e '\052\052 FAILED -- MAKE'; travis_terminate 1; diff --git a/build.info b/build.info index 6b70b11006..a050ae9530 100644 --- a/build.info +++ b/build.info @@ -1,6 +1,6 @@ # Note that some of these directories are filtered in Configure. Look for # %skipdir there for further explanations. -SUBDIRS=crypto ssl apps test util tools fuzz engines providers +SUBDIRS=crypto ssl apps test util tools fuzz engines providers doc/man1 LIBS=libcrypto libssl INCLUDE[libcrypto]=. include @@ -12,6 +12,7 @@ DEPEND[libssl]=libcrypto DEPEND[]=include/openssl/opensslconf.h include/openssl/opensslv.h \ include/crypto/bn_conf.h include/crypto/dso_conf.h \ doc/man7/openssl_user_macros.pod + GENERATE[include/openssl/opensslconf.h]=include/openssl/opensslconf.h.in GENERATE[include/openssl/opensslv.h]=include/openssl/opensslv.h.in GENERATE[include/crypto/bn_conf.h]=include/crypto/bn_conf.h.in diff --git a/doc/man1/build.info b/doc/man1/build.info new file mode 100644 index 0000000000..aed1f948d5 --- /dev/null +++ b/doc/man1/build.info @@ -0,0 +1,84 @@ + +DEPEND[]= \ + openssl-ca.pod \ + openssl-cms.pod \ + openssl-crl.pod \ + openssl-dgst.pod \ + openssl-dhparam.pod \ + openssl-dsaparam.pod \ + openssl-ecparam.pod \ + openssl-enc.pod \ + openssl-gendsa.pod \ + openssl-genrsa.pod \ + openssl-ocsp.pod \ + openssl-passwd.pod \ + openssl-pkcs12.pod \ + openssl-pkcs8.pod \ + openssl-pkeyutl.pod \ + openssl-rand.pod \ + openssl-req.pod \ + openssl-rsautl.pod \ + openssl-s_client.pod \ + openssl-s_server.pod \ + openssl-s_time.pod \ + openssl-smime.pod \ + openssl-speed.pod \ + openssl-srp.pod \ + openssl-ts.pod \ + openssl-verify.pod \ + openssl-x509.pod + +DEPEND[openssl-ca.pod]=../perlvars.pm +GENERATE[openssl-ca.pod]=openssl-ca.pod.in +DEPEND[openssl-cms.pod]=../perlvars.pm +GENERATE[openssl-cms.pod]=openssl-cms.pod.in +DEPEND[openssl-crl.pod]=../perlvars.pm +GENERATE[openssl-crl.pod]=openssl-crl.pod.in +DEPEND[openssl-dgst.pod]=../perlvars.pm +GENERATE[openssl-dgst.pod]=openssl-dgst.pod.in +DEPEND[openssl-dhparam.pod]=../perlvars.pm +GENERATE[openssl-dhparam.pod]=openssl-dhparam.pod.in +DEPEND[openssl-dsaparam.pod]=../perlvars.pm +GENERATE[openssl-dsaparam.pod]=openssl-dsaparam.pod.in +DEPEND[openssl-ecparam.pod]=../perlvars.pm +GENERATE[openssl-ecparam.pod]=openssl-ecparam.pod.in +DEPEND[openssl-enc.pod]=../perlvars.pm +GENERATE[openssl-enc.pod]=openssl-enc.pod.in +DEPEND[openssl-gendsa.pod]=../perlvars.pm +GENERATE[openssl-gendsa.pod]=openssl-gendsa.pod.in +DEPEND[openssl-genrsa.pod]=../perlvars.pm +GENERATE[openssl-genrsa.pod]=openssl-genrsa.pod.in +DEPEND[openssl-ocsp.pod]=../perlvars.pm +GENERATE[openssl-ocsp.pod]=openssl-ocsp.pod.in +DEPEND[openssl-passwd.pod]=../perlvars.pm +GENERATE[openssl-passwd.pod]=openssl-passwd.pod.in +DEPEND[openssl-pkcs8.pod]=../perlvars.pm +GENERATE[openssl-pkcs8.pod]=openssl-pkcs8.pod.in +DEPEND[openssl-pkcs12.pod]=../perlvars.pm +GENERATE[openssl-pkcs12.pod]=openssl-pkcs12.pod.in +DEPEND[openssl-pkeyutl.pod]=../perlvars.pm +GENERATE[openssl-pkeyutl.pod]=openssl-pkeyutl.pod.in +DEPEND[openssl-rand.pod]=../perlvars.pm +GENERATE[openssl-rand.pod]=openssl-rand.pod.in +DEPEND[openssl-req.pod]=../perlvars.pm +GENERATE[openssl-req.pod]=openssl-req.pod.in +DEPEND[openssl-rsautl.pod]=../perlvars.pm +GENERATE[openssl-rsautl.pod]=openssl-rsautl.pod.in +DEPEND[openssl-s_client.pod]=../perlvars.pm +GENERATE[openssl-s_client.pod]=openssl-s_client.pod.in +DEPEND[openssl-s_server.pod]=../perlvars.pm +GENERATE[openssl-s_server.pod]=openssl-s_server.pod.in +DEPEND[openssl-s_time.pod]=../perlvars.pm +GENERATE[openssl-s_time.pod]=openssl-s_time.pod.in +DEPEND[openssl-smime.pod]=../perlvars.pm +GENERATE[openssl-smime.pod]=openssl-smime.pod.in +DEPEND[openssl-speed.pod]=../perlvars.pm +GENERATE[openssl-speed.pod]=openssl-speed.pod.in +DEPEND[openssl-srp.pod]=../perlvars.pm +GENERATE[openssl-srp.pod]=openssl-srp.pod.in +DEPEND[openssl-ts.pod]=../perlvars.pm +GENERATE[openssl-ts.pod]=openssl-ts.pod.in +DEPEND[openssl-verify.pod]=../perlvars.pm +GENERATE[openssl-verify.pod]=openssl-verify.pod.in +DEPEND[openssl-x509.pod]=../perlvars.pm +GENERATE[openssl-x509.pod]=openssl-x509.pod.in diff --git a/doc/man1/openssl-ca.pod b/doc/man1/openssl-ca.pod deleted file mode 100644 index e3d6c7b17c..0000000000 --- a/doc/man1/openssl-ca.pod +++ /dev/null @@ -1,783 +0,0 @@ -=pod - -=head1 NAME - -openssl-ca - sample minimal CA application - -=head1 SYNOPSIS - -B B -[B<-help>] -[B<-verbose>] -[B<-config> I] -[B<-name> I
] -[B<-gencrl>] -[B<-revoke> I] -[B<-valid> I] -[B<-status> I] -[B<-updatedb>] -[B<-crl_reason> I] -[B<-crl_hold> I] -[B<-crl_compromise> I