summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThéo Cavignac <theo.cavignac@ecl16.ec-lyon.fr>2019-02-10 12:11:29 +0100
committerw0rp <w0rp@users.noreply.github.com>2019-02-10 11:11:29 +0000
commitd072d2654c68d1c0bf4a1cb8c15c31e989652669 (patch)
tree42747f3962720331f24cfabb5fa5c38abd203fd7 /doc
parenta24f0b4d5f91f9214c64ae281fadcd981e0dadfc (diff)
downloadale-d072d2654c68d1c0bf4a1cb8c15c31e989652669.zip
Supporting filtered jump (#2279)
* Support filtered jump based on loclist item type (E or W for now) * Use flags to customize the behavior of ALENext and ALEPrevious * Update <plug> bindings with flags * Update documentation about ALENext and ALEPrevious * Use ale#args#Parse in JumpWrap
Diffstat (limited to 'doc')
-rw-r--r--doc/ale.txt22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index f36013ce..40d0eba9 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2467,14 +2467,36 @@ ALELast *ALELast*
`ALEPreviousWrap` and `ALENextWrap` will wrap around the file to find
the last or first warning or error in the file, respectively.
+ `ALEPrevious` and `ALENext` take optional flags arguments to custom their
+ behaviour :
+ `-wrap` enable wrapping around the file
+ `-error`, `-warning` and `-info` enable jumping to errors, warnings or infos
+ respectively, ignoring anything else. They are mutually exclusive and if
+ several are provided the priority is the following: error > warning > info.
+ `-style` and `-nostyle` allow you to jump respectively to style error or
+ warning and to not style error or warning. They also are mutually
+ exclusive and nostyle has priority over style.
+
+ Flags can be combined to create create custom jumping. Thus you can use
+ ":ALENext -wrap -error -nosyle" to jump to the next error which is not a
+ style error while going back to the begining of the file if needed.
+
`ALEFirst` goes to the first error or warning in the buffer, while `ALELast`
goes to the last one.
The following |<Plug>| mappings are defined for the commands: >
<Plug>(ale_previous) - ALEPrevious
<Plug>(ale_previous_wrap) - ALEPreviousWrap
+ <Plug>(ale_previous_error) - ALEPrevious -error
+ <Plug>(ale_previous_wrap_error) - ALEPrevious -wrap -error
+ <Plug>(ale_previous_warning) - ALEPrevious -warning
+ <Plug>(ale_previous_wrap_warning) - ALEPrevious -wrap -warning
<Plug>(ale_next) - ALENext
<Plug>(ale_next_wrap) - ALENextWrap
+ <Plug>(ale_next_error) - ALENext -error
+ <Plug>(ale_next_wrap_error) - ALENext -wrap -error
+ <Plug>(ale_next_warning) - ALENext -warning
+ <Plug>(ale_next_wrap_warning) - ALENext -wrap -warning
<Plug>(ale_first) - ALEFirst
<Plug>(ale_last) - ALELast
<