diff options
author | w0rp <devw0rp@gmail.com> | 2017-01-22 15:19:09 +0000 |
---|---|---|
committer | w0rp <devw0rp@gmail.com> | 2017-01-22 15:31:28 +0000 |
commit | fd89da113d920b693370b457624d12d7d62aa021 (patch) | |
tree | 2c331cc4d697907091c26ff664adc99203fd3116 /doc/ale.txt | |
parent | b2696b105a718367a0725f055ca23642440e3fba (diff) | |
download | ale-fd89da113d920b693370b457624d12d7d62aa021.zip |
Document the new quickfix and loclist options.
Diffstat (limited to 'doc/ale.txt')
-rw-r--r-- | doc/ale.txt | 39 |
1 files changed, 38 insertions, 1 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index d56446a7..173951c9 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -168,6 +168,19 @@ g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str* Note |`g:ale_echo_msg_format`| should contain the `%severity%` handler +g:ale_keep_list_window_open *g:ale_keep_list_window_open* + + Type: |Number| + Default: `0` + + When set to `1`, this option will keep the loclist or quickfix windows + event after all warnings/errors have been removed for files. By default + the loclist or quicfix windows will be closed automatically when there + are no warnings or errors. + + See: |g:ale_open_list| + + g:ale_lint_delay *g:ale_lint_delay* Type: |Number| @@ -278,16 +291,40 @@ g:ale_linters *g:ale_linters* let g:ale_linters = {'c': 'all'} < +g:ale_open_list *g:ale_open_list* + + Type: |Number| + Default: `0` + + When set to `1`, this will cause ALE to automatically open a window for + the loclist (|lopen|) or for the quickfix list instead if + |g:ale_set_quickfix| is `1`. (|copen|) + + The window will be kept open until all warnings or errors are cleared, + including those not set by ALE, unless |g:ale_keep_list_window_open| is set + to `1`, in which case the window will be kept open until closed manually. + + g:ale_set_loclist *g:ale_set_loclist* Type: |Number| Default: `1` - When this option is set to `1`, the |loclist| will be populate with any + When this option is set to `1`, the |loclist| will be populated with any warnings and errors which are found by ALE. This feature can be used to implement jumping between errors through typical use of |lnext| and |lprev|. +g:ale_set_quickfix *g:ale_set_quickfix* + + Type: |Number| + Default: `0` + + When this option is set to `1`, the |quickfix| list will be populated with any + warnings and errors which are found by ALE, instead of the |loclist|. The + loclist will never be populated when this option is on. + + g:ale_set_signs *g:ale_set_signs* Type: |Number| |