diff options
author | zeertzjq <zeertzjq@outlook.com> | 2023-09-28 05:22:09 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-09-28 05:22:09 +0800 |
commit | 86b7d8a9f54d572e6866d6a24476d2369a288f79 (patch) | |
tree | 53362278dcf3b3d6b19c1261d96b35744a15a538 | |
parent | 1783023da7391bb4f66bd603af11b2192dddff3a (diff) | |
download | rneovim-86b7d8a9f54d572e6866d6a24476d2369a288f79.tar.gz rneovim-86b7d8a9f54d572e6866d6a24476d2369a288f79.tar.bz2 rneovim-86b7d8a9f54d572e6866d6a24476d2369a288f79.zip |
vim-patch:5277cfaf8afe (#25397)
runtime(doc): mention mouse scrolling in scrollbind-quickadj (vim/vim#13190)
https://github.com/vim/vim/commit/5277cfaf8afe847b7d4dcde6057fbecb001ab64e
-rw-r--r-- | runtime/doc/options.txt | 6 | ||||
-rw-r--r-- | runtime/doc/scroll.txt | 15 | ||||
-rw-r--r-- | runtime/lua/vim/_meta/options.lua | 6 | ||||
-rw-r--r-- | src/nvim/options.lua | 6 |
4 files changed, 17 insertions, 16 deletions
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 0bbbc95141..84cff775f6 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -4909,9 +4909,9 @@ A jump table for the options with a short description can be found at |Q_op|. *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* 'scrollbind' 'scb' boolean (default off) local to window - See also |scroll-binding|. When this option is set, the current - window scrolls as other scrollbind windows (windows that also have - this option set) scroll. This option is useful for viewing the + See also |scroll-binding|. When this option is set, scrolling the + current window also scrolls other scrollbind windows (windows that + also have this option set). This option is useful for viewing the differences between two versions of a file, see 'diff'. See |'scrollopt'| for options that determine how this option should be interpreted. diff --git a/runtime/doc/scroll.txt b/runtime/doc/scroll.txt index 92546799b4..29d6177213 100644 --- a/runtime/doc/scroll.txt +++ b/runtime/doc/scroll.txt @@ -186,16 +186,16 @@ windows can be given this behavior by setting the (window-specific) other 'scrollbind' windows are scrolled the same amount, if possible. The behavior of 'scrollbind' can be modified by the 'scrollopt' option. -When using the scrollbars, the binding only happens when scrolling the window -with focus (where the cursor is). You can use this to avoid scroll-binding -for a moment without resetting options. +When using the scrollbars or the mouse wheel, the binding only happens when +scrolling the window with focus (where the cursor is). You can use this to +avoid scroll-binding for a moment without resetting options. When a window also has the 'diff' option set, the scroll-binding uses the differences between the two buffers to synchronize the position precisely. Otherwise the following method is used. *scrollbind-relative* -Each 'scrollbind' window keeps track of its "relative offset," which can be +Each 'scrollbind' window keeps track of its "relative offset", which can be thought of as the difference between the current window's vertical scroll position and the other window's vertical scroll position. When one of the 'scrollbind' windows is asked to vertically scroll past the beginning or end @@ -219,9 +219,10 @@ option. *scrollbind-quickadj* The 'scrollbind' flag is meaningful when using keyboard commands to vertically -scroll a window, and also meaningful when using the vertical scrollbar of the -window which has the cursor focus. However, when using the vertical scrollbar -of a window which doesn't have the cursor focus, 'scrollbind' is ignored. +scroll a window, and is also meaningful when using the vertical scrollbar or +the mouse wheel in the window which has the cursor focus. However, when using +the vertical scrollbar or the mouse wheel in a window which doesn't have the +cursor focus, 'scrollbind' is ignored. This allows quick adjustment of the relative offset of 'scrollbind' windows. ============================================================================== diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua index 6ef3cf57e1..ed0d844748 100644 --- a/runtime/lua/vim/_meta/options.lua +++ b/runtime/lua/vim/_meta/options.lua @@ -5113,9 +5113,9 @@ vim.o.scbk = vim.o.scrollback vim.bo.scrollback = vim.o.scrollback vim.bo.scbk = vim.bo.scrollback ---- See also `scroll-binding`. When this option is set, the current ---- window scrolls as other scrollbind windows (windows that also have ---- this option set) scroll. This option is useful for viewing the +--- See also `scroll-binding`. When this option is set, scrolling the +--- current window also scrolls other scrollbind windows (windows that +--- also have this option set). This option is useful for viewing the --- differences between two versions of a file, see 'diff'. --- See `'scrollopt'` for options that determine how this option should be --- interpreted. diff --git a/src/nvim/options.lua b/src/nvim/options.lua index 429a70eb38..cd1d760836 100644 --- a/src/nvim/options.lua +++ b/src/nvim/options.lua @@ -6546,9 +6546,9 @@ return { cb = 'did_set_scrollbind', defaults = { if_true = false }, desc = [=[ - See also |scroll-binding|. When this option is set, the current - window scrolls as other scrollbind windows (windows that also have - this option set) scroll. This option is useful for viewing the + See also |scroll-binding|. When this option is set, scrolling the + current window also scrolls other scrollbind windows (windows that + also have this option set). This option is useful for viewing the differences between two versions of a file, see 'diff'. See |'scrollopt'| for options that determine how this option should be interpreted. |