summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-06-26 22:08:55 +0100
committerw0rp <devw0rp@gmail.com>2017-06-26 22:08:55 +0100
commitb9d91f0e9b94e9ab352f9a7b230f7b0aadec5a45 (patch)
tree7fef20e9939369474d64c1e99ef58d175d5348c5
parentd5c9a4eb8719d733f2a4680f4f0e24128a9dad64 (diff)
downloadale-b9d91f0e9b94e9ab352f9a7b230f7b0aadec5a45.zip
Document :ALEInfo better
-rw-r--r--doc/ale.txt18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index 02fd8699..b0c6acd3 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -1080,6 +1080,24 @@ ALEDetail *ALEDetail*
A plug mapping `<Plug>(ale_detail)` is defined for this command.
+
+ALEInfo *ALEInfo*
+ALEInfoToClipboard *ALEInfoToClipboard*
+
+ Print runtime information about ALE, including the values of global and
+ buffer-local settings for ALE, the linters that are enabled, the commands
+ that have been run, and the output of commands.
+
+ ALE will log the commands that are run by default. If you wish to disable
+ this, set |g:ale_history_enabled| to `0`. Because it could be expensive, ALE
+ does not remember the output of recent commands by default. Set
+ |g:ale_history_log_output| to `1` to enable logging of output for commands.
+ ALE will only log the output captured for parsing problems, etc.
+
+ The command `:ALEInfoToClipboard` can be used to output ALEInfo directly to
+ your clipboard. This might not work on every machine.
+
+
===============================================================================
7. API *ale-api*