summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2016-10-09 20:45:51 +0100
committerw0rp <devw0rp@gmail.com>2016-10-09 20:45:51 +0100
commit07599d006ca35fe5272fd0d5decb25d18e3086a8 (patch)
treeb144982bc61020c2c07bd8ffb2896ea82eb45b9f /doc
parentb5e4538699f2850ca9c9ebfefad8fcbd18fe5eba (diff)
downloadale-07599d006ca35fe5272fd0d5decb25d18e3086a8.zip
Document the default shell option
Diffstat (limited to 'doc')
-rw-r--r--doc/ale.txt14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index 6772c25a..4f05d20b 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -14,6 +14,7 @@ CONTENTS *ale-contents*
4.2. phpcs......................................|ale-linter-options-phpcs|
4.3. c-gcc......................................|ale-linter-options-c-gcc|
4.4. cpp-gcc....................................|ale-linter-options-cpp-gcc|
+ 4.5. shell......................................|ale-linter-options-shell|
5. API............................................|ale-api|
6. Contact........................................|ale-contact|
@@ -286,6 +287,19 @@ Default: `'-Wall'`
This variable can be changed to modify flags given to gcc.
+-------------------------------------------------------------------------------
+4.5. shell *ale-linter-options-shell*
+
+g:ale_linters_sh_shell_default_shell *g:ale_linters_sh_shell_default_shell*
+
+Type: |String|
+Default: The current shell (`$SHELL`) or `'bash'` if that cannot be read.
+
+When ALE runs the linter for shells with the `-n` flag, it will attempt to
+read the shell from the shebang (`#!`) line from the shell script to
+determine the shell program to run. When this detection fails, this variable
+will be used instead.
+
===============================================================================
5. API *ale-api*