aboutsummaryrefslogtreecommitdiffstats
path: root/src/window.c
diff options
context:
space:
mode:
authorLars Ingebrigtsen2020-12-09 20:40:03 +0100
committerLars Ingebrigtsen2020-12-09 20:40:10 +0100
commit7f42cab82cf7aa5435400a03007ffb85590b39e5 (patch)
tree61f6d09c87e81c57577e982e993a3d39c3a8bb83 /src/window.c
parentb71be20eaff7b3b13c67515e7919d36ecbd7b22b (diff)
downloademacs-7f42cab82cf7aa5435400a03007ffb85590b39e5.tar.gz
emacs-7f42cab82cf7aa5435400a03007ffb85590b39e5.zip
Clarify `scroll-preserve-screen-position' doc string
* src/window.c (syms_of_window): Clarify the doc string (bug#7910).
Diffstat (limited to 'src/window.c')
-rw-r--r--src/window.c8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/window.c b/src/window.c
index 5df3e37fbe2..8e75e460b2b 100644
--- a/src/window.c
+++ b/src/window.c
@@ -8246,11 +8246,17 @@ is displayed in the `mode-line' face. */);
8246 DEFVAR_LISP ("scroll-preserve-screen-position", 8246 DEFVAR_LISP ("scroll-preserve-screen-position",
8247 Vscroll_preserve_screen_position, 8247 Vscroll_preserve_screen_position,
8248 doc: /* Controls if scroll commands move point to keep its screen position unchanged. 8248 doc: /* Controls if scroll commands move point to keep its screen position unchanged.
8249
8249A value of nil means point does not keep its screen position except 8250A value of nil means point does not keep its screen position except
8250at the scroll margin or window boundary respectively. 8251at the scroll margin or window boundary respectively.
8252
8251A value of t means point keeps its screen position if the scroll 8253A value of t means point keeps its screen position if the scroll
8252command moved it vertically out of the window, e.g. when scrolling 8254command moved it vertically out of the window, e.g. when scrolling
8253by full screens. 8255by full screens. If point is within `next-screen-context-lines' lines
8256from the edges of the window, point will typically not keep its screen
8257position when doing commands like `scroll-up-command'/`scroll-down-command'
8258and the like.
8259
8254Any other value means point always keeps its screen position. 8260Any other value means point always keeps its screen position.
8255Scroll commands should have the `scroll-command' property 8261Scroll commands should have the `scroll-command' property
8256on their symbols to be controlled by this variable. */); 8262on their symbols to be controlled by this variable. */);