From 912f8a988ac16837ae24b32c863e895283380333 Mon Sep 17 00:00:00 2001 From: Rich Salz Date: Wed, 29 Jan 2020 11:18:39 -0500 Subject: [PATCH] Add cmd-nits to travis build Update CHANGES to have a complete and uniform description. Fixes #9730 Reviewed-by: Matthias St. Pierre Reviewed-by: Dmitry Belyavskiy (Merged from https://github.com/openssl/openssl/pull/10972) --- .travis.yml | 4 ++++ CHANGES | 20 +++++++++++--------- doc/man1/openssl-s_client.pod.in | 2 +- util/find-doc-nits | 10 +++++++--- 4 files changed, 23 insertions(+), 13 deletions(-) diff --git a/.travis.yml b/.travis.yml index 7256b3bccb..b244383d2f 100644 --- a/.travis.yml +++ b/.travis.yml @@ -228,6 +228,10 @@ script: echo -e '\052\052 FAILED -- MAKE'; travis_terminate 1; fi; + - if test -n "$CHECKDOCS" && ! $make cmd-nits; then + echo -e '\052\052 FAILED -- MAKE CMD-NITS'; + travis_terminate 1; + fi - if [ -z "$BUILDONLY" ]; then if [ -n "$CROSS_COMPILE" ]; then sudo dpkg --add-architecture i386; diff --git a/CHANGES b/CHANGES index 7b18d51077..01cec55a65 100644 --- a/CHANGES +++ b/CHANGES @@ -93,6 +93,17 @@ and L. [Paul Dale] + *) Over two thousand fixes were made to the documentation, including: + - Common options (such as -rand/-writerand, TLS version control, etc) + were refactored and point to newly-enhanced descriptions in openssl.pod. + - Added style conformance for all options (with help from Richard Levitte), + documented all reported missing options, added a CI build to check + that all options are documented and that no unimplemented options + are documented. + - Documented some internals, such as all use of environment variables. + - Addressed all internal broken L<> references. + [Rich Salz] + *) All of the low level MD2, MD4, MD5, MDC2, RIPEMD160, SHA1, SHA224, SHA256, SHA384, SHA512 and Whirlpool digest functions have been deprecated. These include: @@ -305,15 +316,6 @@ pages for further details. [Matt Caswell] - *) Most common options (such as -rand/-writerand, TLS version control, etc) - were refactored and point to newly-enhanced descriptions in openssl.pod - [Rich Salz] - - *) Over two thousand fixes were made to the documentation, including: - adding missing command flags, better style conformance, documentation - of internals, etc. - [Rich Salz, Richard Levitte] - *) s390x assembly pack: add hardware-support for P-256, P-384, P-521, X25519, X448, Ed25519 and Ed448. [Patrick Steuer] diff --git a/doc/man1/openssl-s_client.pod.in b/doc/man1/openssl-s_client.pod.in index b64ef7d440..712f99c9d8 100644 --- a/doc/man1/openssl-s_client.pod.in +++ b/doc/man1/openssl-s_client.pod.in @@ -449,7 +449,7 @@ Export keying material using the specified label. =item B<-keymatexportlen> I -Export the specified number of bytes of keyint material; default is 20. +Export the specified number of bytes of keying material; default is 20. Show all protocol messages with hex dump. diff --git a/util/find-doc-nits b/util/find-doc-nits index 901e34f384..25cd6296e9 100755 --- a/util/find-doc-nits +++ b/util/find-doc-nits @@ -22,6 +22,10 @@ use OpenSSL::Util::Pod; # Set to 1 for debug output my $debug = 0; +# Where to find openssl command +my $BLDTOP = $ENV{BLDTOP} || "."; +my $openssl = "$BLDTOP/util/opensslwrap.sh"; + # Options. our($opt_d); our($opt_e); @@ -787,7 +791,7 @@ sub checkflags { my %localskips; # Get the list of options in the command. - open CFH, "./apps/openssl list --options $cmd|" + open CFH, "$openssl list --options $cmd|" or die "Can list options for $cmd, $!"; while ( ) { chop; @@ -847,7 +851,7 @@ if ( $opt_c ) { my @commands = (); # Get list of commands. - open FH, "./apps/openssl list -1 -commands|" + open FH, "$openssl list -1 -commands|" or die "Can't list commands, $!"; while ( ) { chop; @@ -869,7 +873,7 @@ if ( $opt_c ) { } # See what help is missing. - open FH, "./apps/openssl list --missing-help |" + open FH, "$openssl list --missing-help |" or die "Can't list missing help, $!"; while ( ) { chop; -- 2.25.1