summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRaphael Hoegger <pfuender@users.noreply.github.com>2019-04-10 19:52:52 +0200
committerw0rp <w0rp@users.noreply.github.com>2019-04-10 18:52:52 +0100
commit81423701b0378af56d53402b1a95026b71369246 (patch)
tree21dd9e07e9cde7b3cfa7d10e416064dcb12e1bcf /doc
parentabcefe7a6e2555db924d56e3d88f28cf5b6a55e8 (diff)
downloadale-81423701b0378af56d53402b1a95026b71369246.zip
Adding new linter "cookstyle" for chef recipes (Issue #1187) (#2362)
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-chef.txt20
-rw-r--r--doc/ale-supported-languages-and-tools.txt1
-rw-r--r--doc/ale.txt1
3 files changed, 22 insertions, 0 deletions
diff --git a/doc/ale-chef.txt b/doc/ale-chef.txt
index 5024e279..75e144ec 100644
--- a/doc/ale-chef.txt
+++ b/doc/ale-chef.txt
@@ -3,6 +3,26 @@ ALE Chef Integration *ale-chef-options*
===============================================================================
+cookstyle *ale-chef-cookstyle*
+
+g:ale_chef_cookstyle_options *g:ale_chef_cookstyle_options*
+ *b:ale_chef_cookstyle_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be changed to modify flags given to cookstyle.
+
+
+g:ale_chef_cookstyle_executable *g:ale_chef_cookstyle_executable*
+ *b:ale_chef_cookstyle_executable*
+ Type: |String|
+ Default: `'cookstyle'`
+
+ This variable can be changed to point to the cookstyle binary in case it's
+ not on the $PATH or a specific version/path must be used.
+
+
+===============================================================================
foodcritic *ale-chef-foodcritic*
g:ale_chef_foodcritic_options *g:ale_chef_foodcritic_options*
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index 3f329ba2..4307649d 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -71,6 +71,7 @@ Notes:
* `gcc`
* `uncrustify`
* Chef
+ * `cookstyle`
* `foodcritic`
* Clojure
* `joker`
diff --git a/doc/ale.txt b/doc/ale.txt
index 6155dc37..34b5047f 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -1864,6 +1864,7 @@ documented in additional help files.
uncrustify............................|ale-c-uncrustify|
ccls..................................|ale-c-ccls|
chef....................................|ale-chef-options|
+ cookstyle.............................|ale-chef-cookstyle|
foodcritic............................|ale-chef-foodcritic|
clojure.................................|ale-clojure-options|
joker.................................|ale-clojure-joker|