summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorUtkarsh Verma <utkarshverma@protonmail.com>2021-11-15 16:11:03 +0530
committerGitHub <noreply@github.com>2021-11-15 19:41:03 +0900
commit1e0e76bf9619a3ce21663165283f9971556c95b3 (patch)
treef54e5099ef6b248502a039e07d840348c3a9a05a /doc
parent76c2293e68a6cad3b192062743d25b8daa082205 (diff)
downloadale-1e0e76bf9619a3ce21663165283f9971556c95b3.zip
Add support for AVRA linting (#3950)
* Add support for AVRA linting * Add tests for AVRA linting and improve code * Fix test * Fix warning detection * Fix test * Fix test * Add AVRA as a supported language in docs
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-avra.txt26
-rw-r--r--doc/ale-supported-languages-and-tools.txt2
-rw-r--r--doc/ale.txt2
3 files changed, 30 insertions, 0 deletions
diff --git a/doc/ale-avra.txt b/doc/ale-avra.txt
new file mode 100644
index 00000000..a61913ad
--- /dev/null
+++ b/doc/ale-avra.txt
@@ -0,0 +1,26 @@
+===============================================================================
+ALE AVRA Integration *ale-avra-options*
+
+
+===============================================================================
+avra *ale-avra-avra*
+
+g:ale_avra_avra_executable *g:ale_avra_avra_executable*
+ *b:ale_avra_avra_executable*
+
+ Type: |String|
+ Default `'avra'`
+
+ This variable can be changed to use different executable for AVRA.
+
+
+g:ale_avra_avra_options *g:ale_avra_avra_options*
+ *b:ale_avra_avra_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to AVRA.
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index bd23dade..5a780803 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -33,6 +33,8 @@ Notes:
* `write-good`
* ASM
* `gcc`
+* AVRA
+ * `avra`
* Awk
* `gawk`
* Bash
diff --git a/doc/ale.txt b/doc/ale.txt
index 752af42f..88835add 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2633,6 +2633,8 @@ documented in additional help files.
textlint..............................|ale-asciidoc-textlint|
asm.....................................|ale-asm-options|
gcc...................................|ale-asm-gcc|
+ avra....................................|ale-avra-options|
+ avra..................................|ale-avra-avra|
awk.....................................|ale-awk-options|
gawk..................................|ale-awk-gawk|
bats....................................|ale-bats-options|