diff options
| author | Lars Ingebrigtsen | 2020-12-09 20:40:03 +0100 |
|---|---|---|
| committer | Lars Ingebrigtsen | 2020-12-09 20:40:10 +0100 |
| commit | 7f42cab82cf7aa5435400a03007ffb85590b39e5 (patch) | |
| tree | 61f6d09c87e81c57577e982e993a3d39c3a8bb83 /src/window.c | |
| parent | b71be20eaff7b3b13c67515e7919d36ecbd7b22b (diff) | |
| download | emacs-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.c | 8 |
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 | |||
| 8249 | A value of nil means point does not keep its screen position except | 8250 | A value of nil means point does not keep its screen position except |
| 8250 | at the scroll margin or window boundary respectively. | 8251 | at the scroll margin or window boundary respectively. |
| 8252 | |||
| 8251 | A value of t means point keeps its screen position if the scroll | 8253 | A value of t means point keeps its screen position if the scroll |
| 8252 | command moved it vertically out of the window, e.g. when scrolling | 8254 | command moved it vertically out of the window, e.g. when scrolling |
| 8253 | by full screens. | 8255 | by full screens. If point is within `next-screen-context-lines' lines |
| 8256 | from the edges of the window, point will typically not keep its screen | ||
| 8257 | position when doing commands like `scroll-up-command'/`scroll-down-command' | ||
| 8258 | and the like. | ||
| 8259 | |||
| 8254 | Any other value means point always keeps its screen position. | 8260 | Any other value means point always keeps its screen position. |
| 8255 | Scroll commands should have the `scroll-command' property | 8261 | Scroll commands should have the `scroll-command' property |
| 8256 | on their symbols to be controlled by this variable. */); | 8262 | on their symbols to be controlled by this variable. */); |