diff options
| author | w0rp <devw0rp@gmail.com> | 2017-08-30 21:56:43 +0100 |
|---|---|---|
| committer | w0rp <devw0rp@gmail.com> | 2017-08-30 21:56:43 +0100 |
| commit | fca77266bde1ed48b20ec37bab81d05f826e1e6c (patch) | |
| tree | fbe9a7744b81ae071610fa09a305009b3b3da763 | |
| parent | 688212130d7098cbc8079ea9f333fda8dfaf8f9f (diff) | |
| download | ale-fca77266bde1ed48b20ec37bab81d05f826e1e6c.zip | |
Complain about badly aligned documentation on Travis CI, and fix some existing problems
| -rw-r--r-- | doc/ale-awk.txt | 12 | ||||
| -rw-r--r-- | doc/ale-css.txt | 4 | ||||
| -rw-r--r-- | doc/ale-xml.txt | 12 | ||||
| -rwxr-xr-x | 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: `''` @@ -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 |