From fca77266bde1ed48b20ec37bab81d05f826e1e6c Mon Sep 17 00:00:00 2001
From: w0rp <devw0rp@gmail.com>
Date: Wed, 30 Aug 2017 21:56:43 +0100
Subject: [PATCH] Complain about badly aligned documentation on Travis CI, and
 fix some existing problems

---
 doc/ale-awk.txt | 12 ++++++------
 doc/ale-css.txt |  4 ++--
 doc/ale-xml.txt | 12 ++++++------
 run-tests       | 12 ++++++++++++
 4 files changed, 26 insertions(+), 14 deletions(-)

diff --git a/doc/ale-awk.txt b/doc/ale-awk.txt
index d3f23ac7..b9c5c34e 100644
--- a/doc/ale-awk.txt
+++ b/doc/ale-awk.txt
@@ -1,20 +1,20 @@
 ===============================================================================
-ALE Awk Integration                                          *ale-awk-options*
+ALE Awk Integration                                           *ale-awk-options*
 
 
 ===============================================================================
-gawk                                                  *ale-awk-gawk*
+gawk                                                             *ale-awk-gawk*
 
-g:ale_awk_gawk_executable                      *g:ale_awk_gawk_executable*
-                                               *b:ale_awk_gawk_executable*
+g:ale_awk_gawk_executable                           *g:ale_awk_gawk_executable*
+                                                    *b:ale_awk_gawk_executable*
   Type: |String|
   Default: `'gawk'`
 
   This variable sets executable used for gawk.
 
 
-g:ale_awk_gawk_options                            *g:ale_awk_gawk_options*
-                                                  *b:ale_awk_gawk_options*
+g:ale_awk_gawk_options                                 *g:ale_awk_gawk_options*
+                                                       *b:ale_awk_gawk_options*
   Type: |String|
   Default: `''`
 
diff --git a/doc/ale-css.txt b/doc/ale-css.txt
index effa52ad..b1ab8eb8 100644
--- a/doc/ale-css.txt
+++ b/doc/ale-css.txt
@@ -13,8 +13,8 @@ g:ale_css_stylelint_executable                 *g:ale_css_stylelint_executable*
   See |ale-integrations-local-executables|
 
 
-g:ale_css_stylelint_options                    *g:ale_css_stylelint_options*
-                                               *b:ale_css_stylelint_options*
+g:ale_css_stylelint_options                       *g:ale_css_stylelint_options*
+                                                  *b:ale_css_stylelint_options*
   Type: |String|
   Default: `''`
 
diff --git a/doc/ale-xml.txt b/doc/ale-xml.txt
index ddbeb31d..6c8af6c7 100644
--- a/doc/ale-xml.txt
+++ b/doc/ale-xml.txt
@@ -1,20 +1,20 @@
 ===============================================================================
-ALE XML Integration                                         *ale-xml-options*
+ALE XML Integration                                           *ale-xml-options*
 
 
 ===============================================================================
-xmllint                                                    *ale-xml-xmllint*
+xmllint                                                       *ale-xml-xmllint*
 
-g:ale_xml_xmllint_executable                   *g:ale_xml_xmllint_executable*
-                                               *b:ale_xml_xmllint_executable*
+g:ale_xml_xmllint_executable                     *g:ale_xml_xmllint_executable*
+                                                 *b:ale_xml_xmllint_executable*
   Type: |String|
   Default: `'xmllint'`
 
   This variable can be set to change the path to xmllint.
 
 
-g:ale_xml_xmllint_options                         *g:ale_xml_xmllint_options*
-                                                  *b:ale_xml_xmllint_options*
+g:ale_xml_xmllint_options                           *g:ale_xml_xmllint_options*
+                                                    *b:ale_xml_xmllint_options*
   Type: |String|
   Default: `''`
 
diff --git a/run-tests b/run-tests
index a2843580..5b49b3e9 100755
--- a/run-tests
+++ b/run-tests
@@ -243,6 +243,18 @@ if ((run_custom_checks)); then
     echo
 
     ./check-supported-tools-tables || EXIT=$?
+
+    echo '========================================'
+    echo 'Look for badly aligned doc tags'
+    echo '========================================'
+    echo 'Badly aligned tags follow:'
+    echo
+
+    # Documentation tags need to be aligned to the right margin, so look for
+    # tags which aren't at the right margin.
+    grep ' \*[^*]\+\*$' doc/ -r \
+        | awk '{ sep = index($0, ":"); if (length(substr($0, sep + 1 )) < 79) { print } }' \
+        | grep . && EXIT=1
 fi
 
 exit $EXIT