travis: enable markdownlint checks

Reviewed-by: Tomas Mraz <[email protected]>
Reviewed-by: Matthias St. Pierre <[email protected]>
(Merged from openssl#11739)

.travis.yml

@@ -135,7 +135,7 @@ jobs:
           script: true
         - os: linux
           compiler: gcc
-          env: CONFIGURE_TARGET="linux-generic32" CONFIG_OPTS="--strict-warnings no-shared no-dso no-pic no-aria no-async no-autoload-config no-blake2 no-bf no-camellia no-cast no-chacha no-cmac no-cms no-cmp no-comp no-ct no-des no-dgram no-dh no-dsa no-dtls no-ec2m no-engine no-filenames no-gost no-idea no-ktls no-mdc2 no-md4 no-multiblock no-nextprotoneg no-ocsp no-ocb no-poly1305 no-psk no-rc2 no-rc4 no-rmd160 no-seed no-siphash no-siv no-sm2 no-sm3 no-sm4 no-srp no-srtp no-ssl3 no-ssl3-method no-ts no-ui-console no-whirlpool no-asm -DOPENSSL_NO_SECURE_MEMORY -DOPENSSL_SMALL_FOOTPRINT"
+          env: CONFIGURE_TARGET="linux-generic32" MARKDOWNLINT="yes" CONFIG_OPTS="--strict-warnings no-shared no-dso no-pic no-aria no-async no-autoload-config no-blake2 no-bf no-camellia no-cast no-chacha no-cmac no-cms no-cmp no-comp no-ct no-des no-dgram no-dh no-dsa no-dtls no-ec2m no-engine no-filenames no-gost no-idea no-ktls no-mdc2 no-md4 no-multiblock no-nextprotoneg no-ocsp no-ocb no-poly1305 no-psk no-rc2 no-rc4 no-rmd160 no-seed no-siphash no-siv no-sm2 no-sm3 no-sm4 no-srp no-srtp no-ssl3 no-ssl3-method no-ts no-ui-console no-whirlpool no-asm -DOPENSSL_NO_SECURE_MEMORY -DOPENSSL_SMALL_FOOTPRINT"
 
 
 before_script:
@@ -204,6 +204,12 @@ script:
           echo -e '\052\052 FAILED -- MAKE DOC-NITS';
           travis_terminate 1;
       fi
+    - if test -n "$MARKDOWNLINT" ; then
+          echo -e "====START MARKDOWNLINT====";
+          gem install mdl || travis_terminate 1;
+          mdl -s util/markdownlint.rb . || travis_terminate 1;
+          echo -e "====END MARKDOWNLINT====";
+      fi
     - if ! $make2; then
           echo -e '\052\052 FAILED -- MAKE';
           travis_terminate 1;

dev/release-aux/README.md

@@ -1,30 +1,30 @@
 Auxilliary files for dev/release.sh
 ===================================
 
--   release-state-fn.sh
+- release-state-fn.sh
 
-    This is the main version and state update logic...  you could say
-    that it's the innermost engine for the release mechanism.  It
-    tries to be agnostic of versioning schemes, and relies on
-    release-version-fn.sh to supply necessary functions that are
-    specific for versioning schemes.
-
--   release-version-fn.sh
+  This is the main version and state update logic...  you could say
+  that it's the innermost engine for the release mechanism.  It
+  tries to be agnostic of versioning schemes, and relies on
+  release-version-fn.sh to supply necessary functions that are
+  specific for versioning schemes.
 
-    Supplies functions that are specific to versioning schemes:
-
-    get_version() gets the version data from appropriate files.
+- release-version-fn.sh
 
-    set_version() writes the version data to appropriate files.
+  Supplies functions that are specific to versioning schemes:
 
-    fixup_version() updates the version data, given a first argument
-    that instructs it what update to do.
-
--   openssl-announce-pre-release.tmpl and openssl-announce-release.tmpl
+  get_version() gets the version data from appropriate files.
 
-    Templates for announcements
-
--   fixup-*-release.pl and fixup-*-postrelease.pl
+  set_version() writes the version data to appropriate files.
 
-    Fixup scripts for specific files, to be done for the release
-    commit and for the post-release commit.
+  fixup_version() updates the version data, given a first argument
+  that instructs it what update to do.
+
+- openssl-announce-pre-release.tmpl and openssl-announce-release.tmpl
+
+  Templates for announcements
+
+- fixup-*-release.pl and fixup-*-postrelease.pl
+
+  Fixup scripts for specific files, to be done for the release
+  commit and for the post-release commit.

dev/release-aux/fixup-CHANGES.md-postrelease.pl

@@ -18,11 +18,11 @@ BEGIN
     # If this is a pre-release, we do nothing
     if ($RELEASE !~ /^\d+\.\d+\.\d+-(?:alpha|beta)/) {
         $_ = <<_____
-### Changes between $v2 and $RELEASE_TEXT [xx XXX xxxx] ###
+### Changes between $v2 and $RELEASE_TEXT [xx XXX xxxx]
 
  * 
 
-### Changes between $v1 and $v2 [$PREV_RELEASE_DATE] ###
+### Changes between $v1 and $v2 [$PREV_RELEASE_DATE]
 _____
     }
 }

dev/release-aux/fixup-NEWS.md-postrelease.pl

@@ -18,11 +18,11 @@ BEGIN
     # If this is a pre-release, we do nothing
     if ($RELEASE !~ /^\d+\.\d+\.\d+-(?:alpha|beta)/) {
         $_ = <<_____
-### Major changes between OpenSSL $v2 and OpenSSL $RELEASE_TEXT [under development] ###
+### Major changes between OpenSSL $v2 and OpenSSL $RELEASE_TEXT [under development]
 
  * 
 
-### Major changes between OpenSSL $v1 and OpenSSL $v2 [$PREV_RELEASE_DATE] ###
+### Major changes between OpenSSL $v1 and OpenSSL $v2 [$PREV_RELEASE_DATE]
 _____
     }
 }

util/markdownlint.rb

@@ -0,0 +1,21 @@
+# markdownlint style rules for OpenSSL
+# See https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
+
+all
+
+# Use --- and === for H1 and H2.
+rule 'MD003', :style => :setext_with_atx
+# Code blocks are indented
+rule 'MD046', :style => :indented
+
+# Bug in mdl, https://github.com/markdownlint/markdownlint/issues/313
+exclude_rule 'MD007'
+
+exclude_rule 'MD004' # Unordered list style TODO(fix?)
+exclude_rule 'MD005' # Inconsistent indentation for list items at the same level
+exclude_rule 'MD006' # Consider starting bulleted lists at the beginning of the line
+exclude_rule 'MD014' # Dollar signs used before commands without showing output
+exclude_rule 'MD024' # Multiple headers with the same content
+exclude_rule 'MD025' # Multiple top level headers in the same document
+exclude_rule 'MD029' # Ordered list item prefix
+exclude_rule 'MD036' # Emphasis used instead of a header