Add cmd-nits to travis build

Update CHANGES to have a complete and uniform description.

Fixes #9730

Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
(Merged from https://github.com/openssl/openssl/pull/10972)

diff --git a/.travis.yml b/.travis.yml
index 7256b3bccb9c18ab89d47bbdba703da767789c1a..b244383d2fb18bd6f3988f3ba84cb5e676e6bb4f 100644 (file)
--- 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 7b18d510771574615ad92122a103bbb47c628399..01cec55a656d8a4b55fb35027b7132daeee461a7 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -93,6 +93,17 @@
      and L<EVP_MAC_final(3)>.
      [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 b64ef7d440e5c153f8e0fccaf5500c894f4a1f75..712f99c9d8dc4d4dfd77ce6088278edf016bb8f6 100644 (file)
--- 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<len>
 
-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 901e34f384380e9a903f87f1c299015bdd4b1af1..25cd6296e9451efb5eabd814cc9c355e1a82cbbe 100755 (executable)
--- 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 ( <CFH> ) {
         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 ( <FH> ) {
         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 ( <FH> ) {
         chop;