From 9ae2df195865e1f5ce3b1dab8b43c89e59ad471e Mon Sep 17 00:00:00 2001
From: w0rp <devw0rp@gmail.com>
Date: Thu, 10 Aug 2017 10:45:12 +0100
Subject: [PATCH] Automatically check for invalid help tag references, and fix
 some existing documentation issues

---
 doc/ale-java.txt |  6 +++---
 doc/ale-php.txt  |  6 +++---
 doc/ale.txt      |  2 +-
 run-tests        | 21 +++++++++++++++++++++
 4 files changed, 28 insertions(+), 7 deletions(-)

diff --git a/doc/ale-java.txt b/doc/ale-java.txt
index 36d606de..13decb41 100644
--- a/doc/ale-java.txt
+++ b/doc/ale-java.txt
@@ -3,10 +3,10 @@ ALE Java Integration                                         *ale-java-options*
 
 
 ===============================================================================
-checkstyle                                                ale-java-checkstyle
+checkstyle                                                *ale-java-checkstyle*
 
-g:ale_java_checkstyle_options                   g:ale_java_checkstyle_options
-                                                b:ale_java_checkstyle_options
+g:ale_java_checkstyle_options                   *g:ale_java_checkstyle_options*
+                                                *b:ale_java_checkstyle_options*
 
   Type: String
   Default: '-c /google_checks.xml'
diff --git a/doc/ale-php.txt b/doc/ale-php.txt
index 66859888..8865021a 100644
--- a/doc/ale-php.txt
+++ b/doc/ale-php.txt
@@ -63,7 +63,7 @@ g:ale_php_phpcs_use_global                         *g:ale_php_phpcs_use_global*
   See |ale-integrations-local-executables|
 
 
-------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
 phpmd                                                           *ale-php-phpmd*
 
 g:ale_php_phpmd_ruleset                               *g:ale_php_phpmd_ruleset*
@@ -75,8 +75,8 @@ g:ale_php_phpmd_ruleset                               *g:ale_php_phpmd_ruleset*
   the available phpmd rulesets
 
 
-------------------------------------------------------------------------------
-phpstan                                                          *ale-php-stan*
+-------------------------------------------------------------------------------
+phpstan                                                       *ale-php-phpstan*
 
 g:ale_php_phpstan_executable                     *g:ale_php_phpstan_executable*
                                                  *b:ale_php_phpstan_executable*
diff --git a/doc/ale.txt b/doc/ale.txt
index bb7411ad..56308090 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -204,7 +204,7 @@ The following languages and tools are supported.
 * nroff: 'proselint'
 * Objective-C: 'clang'
 * Objective-C++: 'clang'
-* OCaml: 'merlin' (see |ale-linter-integration-ocaml-merlin|)
+* OCaml: 'merlin' (see |ale-ocaml-merlin|)
 * Perl: 'perl' (-c flag), 'perlcritic'
 * PHP: 'hack', 'langserver', 'php' (-l flag), 'phpcs', 'phpmd', 'phpstan'
 * Pod: 'proselint'
diff --git a/run-tests b/run-tests
index b32ac703..eb398d0d 100755
--- a/run-tests
+++ b/run-tests
@@ -55,6 +55,12 @@ while [ $# -ne 0 ]; do
         run_custom_checks=0
         shift
     ;;
+    --custom-checks-only)
+        run_vim_tests=0
+        run_neovim_tests=0
+        run_vint=0
+        shift
+    ;;
     --)
         shift
         break
@@ -211,6 +217,21 @@ if ((run_custom_checks)); then
     echo
 
     grep --exclude=tags -roh '\*.*\*$' doc | sort | uniq -d || EXIT=$?
+
+    echo '========================================'
+    echo 'Checking for invalid tag references'
+    echo '========================================'
+    echo 'Invalid tag references tags follow:'
+    echo
+
+    tag_regex='[gb]\?:\?\(ale\|ALE\)[a-zA-Z_\-]\+'
+
+    # Grep for tags and references, and complain if we find a reference without
+    # a tag for the reference. Only our tags will be included.
+    diff -u \
+        <(grep --exclude=tags -roh "\*$tag_regex\*" doc | sort -u | sed 's/*//g') \
+        <(grep --exclude=tags -roh "|$tag_regex|" doc | sort -u | sed 's/|//g') \
+        | grep '^+[^+]' && EXIT=1
 fi
 
 exit $EXIT