From d7f8324c3c9b9eb6ea49591fc4fa37948996170d Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 28 Mar 2017 23:25:44 +0100 Subject: Move linter documentation into separate files --- doc/ale-sh.txt | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 doc/ale-sh.txt (limited to 'doc/ale-sh.txt') diff --git a/doc/ale-sh.txt b/doc/ale-sh.txt new file mode 100644 index 00000000..aee13912 --- /dev/null +++ b/doc/ale-sh.txt @@ -0,0 +1,31 @@ +=============================================================================== +ALE Shell Integration *ale-sh-options* + + +------------------------------------------------------------------------------- +shell *ale-sh-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. + + +------------------------------------------------------------------------------- +shellcheck *ale-sh-shellcheck* + +g:ale_linters_sh_shellcheck_exclusions *g:ale_linters_sh_shellcheck_exclusions* + + Type: |String| + Default: `''` + + Set this variable to exclude test(s) for shellcheck (-e/--exclude option). + + +------------------------------------------------------------------------------- + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: -- cgit v1.2.3