diff options
| author | Holden <holden@axoni.com> | 2019-01-02 19:05:51 -0500 |
|---|---|---|
| committer | Holden <holden@axoni.com> | 2019-01-02 19:05:51 -0500 |
| commit | 5f613a5fd69f4135d892a71b1f825f062ff45758 (patch) | |
| tree | 3eb615bb5076687f4e75a0aa7b562d70ba37d138 /doc/ale.txt | |
| parent | 8550fa605958bff90d727cde949ae2b06b870f8f (diff) | |
| download | ale-5f613a5fd69f4135d892a71b1f825f062ff45758.zip | |
change ale to use value of g:ale_shell regardless of what it is
Diffstat (limited to 'doc/ale.txt')
| -rw-r--r-- | doc/ale.txt | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index 7b5fa624..a827e77a 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1993,14 +1993,17 @@ g:ale_windows_node_executable_path *g:ale_windows_node_executable_path* g:ale_shell *g:ale_shell* Type: |String| - Default: `'&shell'` + Default: not set This variable is used to determine which shell ale will use to execute - commands. This variables defaults to the value of the vim option '&shell' - which corresponds to the $SHELL environment variable. For example - if `$SHELL == '/bin/bash'`, but you want to use zsh, set `g:ale_shell = '/bin/zsh'.` - If this option is set to either `fish` or `pwsh` (either by default or set - with this command), ale will still execute commands with `bin/sh`. + commands. By default this variable is undefined, meaning that ALE will use + it's default behavior. Which is to run shells via the shell determined by + the `&shell` vim variable, with the arguments `&shellcmdflag`. Ale will fall + back to using `/bin/sh`if it detects the underlying `&shell`is either `fish` + or `pwsh`. However, if you set this variable ALE will no longer fall back to + other shells, meaning if you wanted to use `fish` you could do so via this + option. For example if `$SHELL == '/bin/bash'`, but you want to use zsh, + set `g:ale_shell = '/bin/zsh'. Please note - if you are using this option you should consider additionally setting `g:ale``g:ale_shell_arguments` since the default values for that @@ -2009,12 +2012,11 @@ g:ale_shell *g:ale_shell* g:ale_shell_arguments *g:ale_shell_arguments* Type: |String| - Default: `'&shellcmdflag'` + Default: not set This variable is used to determine what commands vim will pass to the shell - to execute it's commands. By default, `&shellcmdflag` would be set to the - value of '`-c'`. Similar to `g:ale_shell`, if the shell is set to either - `fish` or `pwsh`, `g:ale_shell_arguments` will no be used. + to execute it's commands. If this command is not set, but g:ale_shell is + set, ale will use `&shellcmdflag` as command arguments. ------------------------------------------------------------------------------- 6.1. Highlights *ale-highlights* |