summaryrefslogtreecommitdiff
path: root/doc/ale-chef.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ale-chef.txt')
-rw-r--r--doc/ale-chef.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/ale-chef.txt b/doc/ale-chef.txt
new file mode 100644
index 00000000..de5a4926
--- /dev/null
+++ b/doc/ale-chef.txt
@@ -0,0 +1,25 @@
+===============================================================================
+ALE Chef Integration *ale-chef-options*
+
+
+-------------------------------------------------------------------------------
+foodcritc *ale-chef-foodcritic*
+
+g:ale_chef_foodcritic_options *g:ale_chef_foodcritic_options*
+
+ Type: |String|
+ Default: `''`
+
+ This variable can be changed to modify flags given to foodcritic.
+
+
+g:ale_chef_foodcritic_executable *g:ale_chef_foodcritic_executable*
+
+ Type: |String|
+ Default: `'foodcritic'`
+
+ This variable can be changed to point to the foodcritic binary in case it's
+ not on the $PATH or a specific version/path must be used.
+
+-------------------------------------------------------------------------------
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: