[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 7f42cab: Clarify `scroll-preserve-screen-position' doc string
From: |
Lars Ingebrigtsen |
Subject: |
master 7f42cab: Clarify `scroll-preserve-screen-position' doc string |
Date: |
Wed, 9 Dec 2020 14:40:16 -0500 (EST) |
branch: master
commit 7f42cab82cf7aa5435400a03007ffb85590b39e5
Author: Lars Ingebrigtsen <larsi@gnus.org>
Commit: Lars Ingebrigtsen <larsi@gnus.org>
Clarify `scroll-preserve-screen-position' doc string
* src/window.c (syms_of_window): Clarify the doc string (bug#7910).
---
src/window.c | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/src/window.c b/src/window.c
index 5df3e37..8e75e46 100644
--- a/src/window.c
+++ b/src/window.c
@@ -8246,11 +8246,17 @@ is displayed in the `mode-line' face. */);
DEFVAR_LISP ("scroll-preserve-screen-position",
Vscroll_preserve_screen_position,
doc: /* Controls if scroll commands move point to keep its
screen position unchanged.
+
A value of nil means point does not keep its screen position except
at the scroll margin or window boundary respectively.
+
A value of t means point keeps its screen position if the scroll
command moved it vertically out of the window, e.g. when scrolling
-by full screens.
+by full screens. If point is within `next-screen-context-lines' lines
+from the edges of the window, point will typically not keep its screen
+position when doing commands like `scroll-up-command'/`scroll-down-command'
+and the like.
+
Any other value means point always keeps its screen position.
Scroll commands should have the `scroll-command' property
on their symbols to be controlled by this variable. */);
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- master 7f42cab: Clarify `scroll-preserve-screen-position' doc string,
Lars Ingebrigtsen <=