summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-11-22 13:01:13 +0000
committerw0rp <devw0rp@gmail.com>2017-11-22 13:01:13 +0000
commit3f70f1cbf1baee707fe78968f57950b78fc6c19b (patch)
tree629c776330271c9d34efd22f17fd89c3c1fc72de /doc
parente7865d2f9482497b568c11cf1f07a740d2da3907 (diff)
downloadale-3f70f1cbf1baee707fe78968f57950b78fc6c19b.zip
Disable piping buffer data into commands for fixing files where needed
Diffstat (limited to 'doc')
-rw-r--r--doc/ale.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index 63991113..ff8ac082 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -479,6 +479,18 @@ are supported for running the commands.
that are cached. An empty List will be passed to the
next callback in the chain for the `output`.
+ `read_buffer` An optional key for disabling reading the buffer.
+
+ When set to `0`, ALE will not pipe the buffer's data
+ into the command via stdin. This option is ignored and
+ the buffer is not read when `read_temporary_file` is
+ `1`.
+
+ This option defaults to `0` when `chain_with` is defined
+ as anything other than `v:null`, and defaults to `1`
+ otherwise. This is so earlier commands in a chain
+ do not receive the buffer's data by default.
+
*ale-fix-configuration*
Synchronous functions and asynchronous jobs will be run in a sequence for