summaryrefslogtreecommitdiffstats
path: root/runtime/doc/sign.txt
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2018-12-29 18:53:55 +0100
committerBram Moolenaar <Bram@vim.org>2018-12-29 18:53:55 +0100
commit7d83bf4f2b785b46d87c7bc376fc9d0a862af782 (patch)
tree0676cfef64951ed975c086173f1099998b7dfb94 /runtime/doc/sign.txt
parent01e51e5b305c13c68b5ea2b9e14779e1e88664ef (diff)
patch 8.1.0658: deleting signs and completion for :sign is insufficientv8.1.0658
Problem: Deleting signs and completion for :sign is insufficient. Solution: Add deleting signs in a specified or any group from the current cursor location. Add group and priority to sign command completion. Add tests for different sign unplace commands. Update help text. Add tests for sign jump with group. Update help for sign jump. (Yegappan Lakshmanan, closes #3731)
Diffstat (limited to 'runtime/doc/sign.txt')
-rw-r--r--runtime/doc/sign.txt35
1 files changed, 29 insertions, 6 deletions
diff --git a/runtime/doc/sign.txt b/runtime/doc/sign.txt
index 12b7fb63c1..166c3a48b2 100644
--- a/runtime/doc/sign.txt
+++ b/runtime/doc/sign.txt
@@ -251,13 +251,24 @@ See |sign_unplace()| for the equivalent Vim script function.
all the files it appears in.
:sign unplace *
- Remove all placed signs in the global group.
+ Remove placed signs in the global group from all the files.
+
+:sign unplace * group={group}
+ Remove placed signs in group {group} from all the files.
:sign unplace * group=*
- Remove all placed signs in all the groups.
+ Remove placed signs in all the groups from all the files.
:sign unplace
- Remove the placed sign at the cursor position.
+ Remove a placed sign at the cursor position. If multiple signs
+ are placed in the line, then only one is removed.
+
+:sign unplace group={group}
+ Remove a placed sign in group {group} at the cursor
+ position.
+
+:sign unplace group=*
+ Remove a placed sign in any group at the cursor position.
LISTING PLACED SIGNS *:sign-place-list*
@@ -271,20 +282,26 @@ See |sign_getplaced()| for the equivalent Vim script function.
:sign place group={group} file={fname}
List signs in group {group} placed in file {fname}.
+:sign place group=* file={fname}
+ List signs in all the groups placed in file {fname}.
+
:sign place buffer={nr}
List signs placed in buffer {nr}.
:sign place group={group} buffer={nr}
List signs in group {group} placed in buffer {nr}.
-:sign place List placed signs in all files.
+:sign place group=* buffer={nr}
+ List signs in all the groups placed in buffer {nr}.
-:sign place group=*
- List placed signs in all sign groups in all files.
+:sign place List placed signs in the global group in all files.
:sign place group={group}
List placed signs with sign group {group} in all files.
+:sign place group=*
+ List placed signs in all sign groups in all files.
+
JUMPING TO A SIGN *:sign-jump* *E157*
@@ -295,9 +312,15 @@ JUMPING TO A SIGN *:sign-jump* *E157*
If the file isn't displayed in window and the current file can
not be |abandon|ed this fails.
+:sign jump {id} group={group} file={fname}
+ Same but jump to the sign in group {group}
+
:sign jump {id} buffer={nr} *E934*
Same, but use buffer {nr}. This fails if buffer {nr} does not
have a name.
+:sign jump {id} group={group} buffer={nr}
+ Same but jump to the sign in group {group}
+
vim:tw=78:ts=8:noet:ft=help:norl: