diff options
| author | w0rp <devw0rp@gmail.com> | 2017-02-09 23:32:57 +0000 |
|---|---|---|
| committer | w0rp <devw0rp@gmail.com> | 2017-02-09 23:32:57 +0000 |
| commit | 5de445c041432b602c590a175809d89837cdf2b8 (patch) | |
| tree | a8d281f1bffcd999d876cd500c67687e228c5300 /doc | |
| parent | 9f8c76b5b939c3a73937069dc1c29efeb2eae49f (diff) | |
| download | ale-5de445c041432b602c590a175809d89837cdf2b8.zip | |
Fix #315 Implement the read_buffer option
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale.txt | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index 348be809..a4d476c3 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1082,10 +1082,14 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* See the `output_stream` description for more information. - The Vim buffer being checked for linter will only - be sent to the final command in the chain. Previous - commands in the chain will receive no input from - stdin. + Commands in the chain all behave as if `read_buffer` + is set to `0` by default, except for the last command + in the chain, which uses the value set for + `read_buffer` in the root |Dictionary|. Each command + in the chain can also provide a `read_buffer` key + to override these values. + See the `read_buffer` description for more + information. `output_stream` A |String| for the output stream the lines of output should be read from for the command which is run. The @@ -1096,6 +1100,12 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* instead of stdout. The option `'both'` will read from both stder and stdout at the same time. + `read_buffer` A |Number| (`0` or `1`) indicating whether a command + should read the Vim buffer as input via stdin. This + option is set to `1` by default, and can be disabled + if a command manually reads from a temporary file + instead, etc. + Only one of `command`, `command_callback`, or `command_chain` should be specified. `command_callback` is generally recommended when a command string needs to be generated dynamically, or any global options are used. |