[Emacs-diffs] /srv/bzr/emacs/emacs-24 r110910: Emacs manual fixes regarding automatic scrolling.

[Chong Yidong]

------------------------------------------------------------
revno: 110910
fixes bug: http://debbugs.gnu.org/12865
author: Dani Moncayo <address@hidden>
committer: Chong Yidong <address@hidden>
branch nick: emacs-24
timestamp: Sun 2012-11-18 14:27:43 +0800
message:
  Emacs manual fixes regarding automatic scrolling.
  
  * display.texi (Auto Scrolling): Fix some inaccuracies, plus
  clarifications.
  (Horizontal Scrolling): Clarifications.
modified:
  doc/emacs/ChangeLog
  doc/emacs/display.texi

=== modified file 'doc/emacs/ChangeLog'
--- a/doc/emacs/ChangeLog       2012-11-17 06:38:05 +0000
+++ b/doc/emacs/ChangeLog       2012-11-18 06:27:43 +0000
@@ -1,3 +1,9 @@
+2012-11-18  Dani Moncayo  <address@hidden>
+
+       * display.texi (Auto Scrolling): Fix some inaccuracies, plus
+       clarifications (Bug#12865).
+       (Horizontal Scrolling): Clarifications.
+
 2012-11-17  Dani Moncayo  <address@hidden>
 
        * mark.texi (Disabled Transient Mark): Doc fixes (Bug#12746).

=== modified file 'doc/emacs/display.texi'
--- a/doc/emacs/display.texi    2012-11-07 20:43:38 +0000
+++ b/doc/emacs/display.texi    2012-11-18 06:27:43 +0000
@@ -213,59 +213,62 @@
 @node Auto Scrolling
 @section Automatic Scrolling
 
address@hidden automatic scrolling
   Emacs performs @dfn{automatic scrolling} when point moves out of the
-visible portion of the text.
+visible portion of the text.  Normally, automatic scrolling centers
+point vertically in the window, but there are several ways to alter
+this behavior.
 
 @vindex scroll-conservatively
-  Normally, this centers point vertically within the window.  However,
-if you set @code{scroll-conservatively} to a small number @var{n},
-then if you move point just a little off the screen (less than @var{n}
-lines), Emacs scrolls the text just far enough to bring point back on
-screen.  If doing so fails to make point visible, Emacs centers point
-in the window.  By default, @code{scroll-conservatively} address@hidden
-If you set @code{scroll-conservatively} to a large number (larger than
-100), Emacs will never center point as result of scrolling, even if
-point moves far away from the text previously displayed in the window.
-With such a large value, Emacs will always scroll text just enough for
-bringing point into view, so point will end up at the top or bottom of
-the window, depending on the scroll direction.
+  If you set @code{scroll-conservatively} to a small number @var{n},
+then moving point just a little off the screen (no more than @var{n}
+lines) causes Emacs to scroll just enough to bring point back on
+screen; if doing so fails to make point visible, Emacs scrolls just
+far enough to center point in the window.  If you set
address@hidden to a large number (larger than 100),
+automatic scrolling never centers point, no matter how far point
+moves; Emacs always scrolls text just enough to bring point into view,
+either at the top or bottom of the window depending on the scroll
+direction.  By default, @code{scroll-conservatively} address@hidden, which
+means to always center point in the window.
 
 @vindex scroll-step
-  An alternative way of controlling how Emacs scrolls text is by
-customizing the variable @code{scroll-step}.  Its value determines how
-many lines to scroll the window when point moves off the screen.  If
-moving by that number of lines fails to bring point back into view,
-point is centered instead.  The default value is zero, which causes
-point to always be centered after scrolling.
-
-  Since both @code{scroll-conservatively} and @code{scroll-step}
-control automatic scrolling in contradicting ways, you should set only
-one of them.  If you customize both, the value of
address@hidden takes precedence.
+  Another way to control automatic scrolling is to customize the
+variable @code{scroll-step}.  Its value determines the number of lines
+by which to automatically scroll, when point moves off the screen.  If
+scrolling by that number of lines fails to bring point back into view,
+point is centered instead.  The default value is zero, which (by
+default) causes point to always be centered after scrolling.
 
 @cindex aggressive scrolling
 @vindex scroll-up-aggressively
 @vindex scroll-down-aggressively
-  When the window does scroll by a distance longer than
address@hidden, you can control how aggressively it scrolls by
-setting the variables @code{scroll-up-aggressively} and
address@hidden  The value of
address@hidden should be either @code{nil}, or a
-fraction @var{f} between 0 and 1.  A fraction specifies where on the
-screen to put point when scrolling upward, i.e.@: forward.  When point
-goes off the window end, the new start position is chosen to put point
address@hidden parts of the window height from the bottom margin.  Thus,
-larger @var{f} means more aggressive scrolling: more new text is
-brought into view.  The default value, @code{nil}, is equivalent to
-0.5.
-
-  Likewise, @code{scroll-down-aggressively} is used for scrolling
-down, i.e.@: backward.  The value specifies how far point should be
-placed from the top margin of the window; thus, as with
address@hidden, a larger value is more aggressive.
-
-  These two variables are ignored if either @code{scroll-step} or
address@hidden are set to a non-zero value.
+  A third way to control automatic scrolling is to customize the
+variables @code{scroll-up-aggressively} and
address@hidden, which directly specify the vertical
+position of point after scrolling.  The value of
address@hidden should be either @code{nil} (the
+default), or a floating point number @var{f} between 0 and 1.  The
+latter means that when point goes below the bottom window edge (i.e.@:
+scrolling forward), Emacs scrolls the window so that point is @var{f}
+parts of the window height from the bottom window edge.  Thus, larger
address@hidden means more aggressive scrolling: more new text is brought into
+view.  The default value, @code{nil}, is equivalent to 0.5.
+
+  Likewise, @code{scroll-down-aggressively} is used when point goes
+above the bottom window edge (i.e.@: scrolling backward).  The value
+specifies how far point should be from the top margin of the window
+after scrolling.  Thus, as with @code{scroll-up-aggressively}, a
+larger value is more aggressive.
+
+  Note that the variables @code{scroll-conservatively},
address@hidden, and @code{scroll-up-aggressively} /
address@hidden control automatic scrolling in
+contradictory ways.  Therefore, you should pick no more than one of
+these methods to customize automatic scrolling.  In case you customize
+multiple variables, the order of priority is:
address@hidden, then @code{scroll-step}, and finally
address@hidden / @code{scroll-down-aggressively}.
 
 @vindex scroll-margin
   The variable @code{scroll-margin} restricts how close point can come
@@ -295,10 +298,10 @@
 
 @vindex hscroll-margin
   The variable @code{hscroll-margin} controls how close point can get
-to the window's edges before automatic scrolling occurs.  It is
-measured in columns.  For example, if the value is 5, then moving
-point within 5 columns of an edge causes horizontal scrolling away
-from that edge.
+to the window's left and right edges before automatic scrolling
+occurs.  It is measured in columns.  For example, if the value is 5,
+then moving point within 5 columns of an edge causes horizontal
+scrolling away from that edge.
 
 @vindex hscroll-step
   The variable @code{hscroll-step} determines how many columns to