Merge commit '76265755a1add77121c8f9dabb3e9bb70fe9a972' as '.vim/bundle/ale'

[etc/vim.git] / .vim / bundle / ale / doc / ale-chef.txt

diff --git a/.vim/bundle/ale/doc/ale-chef.txt b/.vim/bundle/ale/doc/ale-chef.txt
new file mode 100644 (file)
index 0000000..d4f931f
--- /dev/null
+++ b/.vim/bundle/ale/doc/ale-chef.txt
@@ -0,0 +1,56 @@
+===============================================================================
+ALE Chef Integration                                         *ale-chef-options*
+
+
+===============================================================================
+cookstyle                                                  *ale-chef-cookstyle*
+
+                                           *ale-options.chef_cookstyle_options*
+                                                 *g:ale_chef_cookstyle_options*
+                                                 *b:ale_chef_cookstyle_options*
+chef_cookstyle_options
+g:ale_chef_cookstyle_options
+  Type: |String|
+  Default: `''`
+
+  This variable can be changed to modify flags given to cookstyle.
+
+                                        *ale-options.chef_cookstyle_executable*
+                                              *g:ale_chef_cookstyle_executable*
+                                              *b:ale_chef_cookstyle_executable*
+chef_cookstyle_executable
+g: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*
+
+                                          *ale-options.chef_foodcritic_options*
+                                                *g:ale_chef_foodcritic_options*
+                                                *b:ale_chef_foodcritic_options*
+chef_foodcritic_options
+g:ale_chef_foodcritic_options
+  Type: |String|
+  Default: `''`
+
+  This variable can be changed to modify flags given to foodcritic.
+
+                                       *ale-options.chef_foodcritic_executable*
+                                             *g:ale_chef_foodcritic_executable*
+                                             *b:ale_chef_foodcritic_executable*
+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: