summaryrefslogtreecommitdiff
path: root/doc/ale-awk.txt
diff options
context:
space:
mode:
authorMark Korondi <korondi.mark@gmail.com>2017-06-08 19:26:21 +0200
committerw0rp <w0rp@users.noreply.github.com>2017-06-08 18:26:21 +0100
commit64ad51048d8f490b57ca6e74864f4de3777ec2a7 (patch)
treec657a7dccd67de80518d56d90dc55b39c5bd88c1 /doc/ale-awk.txt
parent62862c334776e3138f5a5456ed41bb146969b2c2 (diff)
downloadale-64ad51048d8f490b57ca6e74864f4de3777ec2a7.zip
Support for GNU Awk linting (#638)
* GNU Awk linter support * Documentation for awk linter
Diffstat (limited to 'doc/ale-awk.txt')
-rw-r--r--doc/ale-awk.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/ale-awk.txt b/doc/ale-awk.txt
new file mode 100644
index 00000000..221bf8de
--- /dev/null
+++ b/doc/ale-awk.txt
@@ -0,0 +1,25 @@
+===============================================================================
+ALE Awk Integration *ale-awk-options*
+
+
+-------------------------------------------------------------------------------
+gawk *ale-awk-gawk*
+
+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*
+ Type: |String|
+ Default: `''`
+
+ With this variable we are able to pass extra arguments for gawk
+ for invocation.
+
+-------------------------------------------------------------------------------
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: