aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorJames McCoy <jamessan@jamessan.com>2021-12-05 15:36:54 -0500
committerJames McCoy <jamessan@jamessan.com>2021-12-08 21:47:58 -0500
commite8f9262125535bea8c7fcf833a715b569e07996e (patch)
treeecbbd94671bac26098f270f016c6f02956047bfc /runtime
parent2cd815c0af3eded9771df94532b4fb3817f2d3c6 (diff)
downloadrneovim-e8f9262125535bea8c7fcf833a715b569e07996e.tar.gz
rneovim-e8f9262125535bea8c7fcf833a715b569e07996e.tar.bz2
rneovim-e8f9262125535bea8c7fcf833a715b569e07996e.zip
vim-patch:8.2.3664: cannot adjust sign highlighting for 'cursorline'
Problem: Cannot adjust sign highlighting for 'cursorline'. Solution: Add CursorLineSign and CursorLineFold highlight groups. (Gregory Anders, closes vim/vim#9201) https://github.com/vim/vim/commit/e413ea04b716effb28eb49dbc98ad3f9f761545a
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/sign.txt18
-rw-r--r--runtime/doc/syntax.txt4
2 files changed, 21 insertions, 1 deletions
diff --git a/runtime/doc/sign.txt b/runtime/doc/sign.txt
index 895ee5ebef..641e193b5e 100644
--- a/runtime/doc/sign.txt
+++ b/runtime/doc/sign.txt
@@ -47,6 +47,8 @@ The color of the column is set with the SignColumn highlight group
:highlight SignColumn guibg=darkgrey
<
+If 'cursorline' is enabled, then the CursorLineSign highlight group is used
+|hl-CursorLineSign|.
*sign-identifier*
Each placed sign is identified by a number called the sign identifier. This
identifier is used to jump to the sign or to remove the sign. The identifier
@@ -156,6 +158,13 @@ See |sign_getdefined()| for the equivalent Vim script function.
:sign list {name}
Lists one defined sign and its attributes.
+ culhl={group}
+ Highlighting group used for the text item when the cursor is
+ on the same line as the sign and 'cursorline' is enabled.
+
+ Example: >
+ :sign define MySign text=>> texthl=Search linehl=DiffText
+<
PLACING SIGNS *:sign-place* *E158*
@@ -377,6 +386,9 @@ sign_define({list})
text text that is displayed when there is no icon
or the GUI is not being used.
texthl highlight group used for the text item
+ culhl highlight group used for the text item when
+ the cursor is on the same line as the sign and
+ 'cursorline' is enabled.
numhl highlight group used for 'number' column at the
associated line. Overrides |hl-LineNr|,
|hl-CursorLineNr|.
@@ -425,9 +437,13 @@ sign_getdefined([{name}]) *sign_getdefined()*
or the GUI is not being used.
texthl highlight group used for the text item; not
present if not set.
+ culhl highlight group used for the text item when
+ the cursor is on the same line as the sign and
+ 'cursorline' is enabled; not present if not
+ set.
numhl highlight group used for 'number' column at the
associated line. Overrides |hl-LineNr|,
- |hl-CursorLineNr|.
+ |hl-CursorLineNr|; not present if not set.
Returns an empty List if there are no signs and when {name} is
not found.
diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt
index b57b8bfd5c..d49809599d 100644
--- a/runtime/doc/syntax.txt
+++ b/runtime/doc/syntax.txt
@@ -5127,6 +5127,10 @@ LineNrBelow Line number for when the 'relativenumber'
*hl-CursorLineNr*
CursorLineNr Like LineNr when 'cursorline' is set and 'cursorlineopt'
contains "number" or is "both", for the cursor line.
+ *hl-CursorLineSign*
+CursorLineSign Like SignColumn when 'cursorline' is set for the cursor line.
+ *hl-CursorLineFold*
+CursorLineFold Like FoldColumn when 'cursorline' is set for the cursor line.
*hl-MatchParen*
MatchParen The character under the cursor or just before it, if it
is a paired bracket, and its match. |pi_paren.txt|