[Emacs-diffs] /srv/bzr/emacs/trunk r106978: * display.texi (Fringe Indicators): Clarify fringe-indicator-alist doc.

[Chong Yidong]

------------------------------------------------------------
revno: 106978
fixes bug(s): http://debbugs.gnu.org/8568
committer: Chong Yidong <address@hidden>
branch nick: trunk
timestamp: Sat 2012-01-28 21:47:42 +0800
message:
  * display.texi (Fringe Indicators): Clarify fringe-indicator-alist doc.
modified:
  doc/lispref/ChangeLog
  doc/lispref/display.texi

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2012-01-28 04:26:33 +0000
+++ b/doc/lispref/ChangeLog     2012-01-28 13:47:42 +0000
@@ -1,5 +1,8 @@
 2012-01-28  Chong Yidong  <address@hidden>
 
+       * display.texi (Fringe Indicators): Clarify fringe-indicator-alist
+       doc (Bug#8568).
+
        * frames.texi (Input Focus): Add NORECORD arg to
        select-frame-set-input-focus.  Clarify its role in select-frame.
 

=== modified file 'doc/lispref/display.texi'
--- a/doc/lispref/display.texi  2012-01-19 07:21:25 +0000
+++ b/doc/lispref/display.texi  2012-01-28 13:47:42 +0000
@@ -3367,54 +3367,48 @@
 
 @defvar fringe-indicator-alist
 This buffer-local variable specifies the mapping from logical fringe
-indicators to the actual bitmaps displayed in the window fringes.
+indicators to the actual bitmaps displayed in the window fringes.  The
+value is an alist of elements @code{(@var{indicator}
+. @var{bitmaps})}, where @var{indicator} specifies a logical indicator
+type and @var{bitmaps} specifies the fringe bitmaps to use for that
+indicator.
 
-These symbols identify the logical fringe indicators:
+  Each @var{indicator} should be one of the following symbols:
 
 @table @asis
address@hidden Truncation and continuation line indicators:
address@hidden, @code{continuation}.
-
address@hidden Buffer position indicators:
address@hidden, @code{down},
address@hidden, @code{bottom},
address@hidden
-
address@hidden Empty line indicator:
address@hidden
-
address@hidden Overlay arrow indicator:
address@hidden
-
address@hidden Unknown bitmap indicator:
address@hidden
address@hidden @code{truncation}, @code{continuation}.
+Used for truncation and continuation lines.
+
address@hidden @code{up}, @code{down}, @code{top}, @code{bottom}, 
@code{top-bottom}
+Used to indicate buffer boundaries when
address@hidden is address@hidden: @code{up} and
address@hidden indicate a buffer boundary lying above or below the window
+edge; @code{top} and @code{bottom} indicate the topmost and bottommost
+buffer text line; and @code{top-bottom} indicates where there is just
+one line of text in the buffer.
+
address@hidden @code{empty-line}
+Used to indicate empty lines when @code{indicate-empty-lines} is
address@hidden
+
address@hidden @code{overlay-arrow}
+Used for overlay arrows (@pxref{Overlay Arrow}).
address@hidden Is this used anywhere?
address@hidden @item Unknown bitmap indicator:
address@hidden @code{unknown}.
 @end table
 
-  The value is an alist where each element @code{(@var{indicator} . 
@var{bitmaps})}
-specifies the fringe bitmaps used to display a specific logical
-fringe indicator.
-
-Here, @var{indicator} specifies the logical indicator type, and
address@hidden is list of symbols @code{(@var{left} @var{right}
address@hidden @var{right1}])} which specifies the actual bitmap shown
-in the left or right fringe for the logical indicator.
-
-The @var{left} and @var{right} symbols specify the bitmaps shown in
-the left and/or right fringe for the specific indicator.  The
address@hidden or @var{right1} bitmaps are used only for the `bottom' and
-`top-bottom indicators when the last (only) line in has no final
-newline.  Alternatively, @var{bitmaps} may be a single symbol which is
-used in both left and right fringes.
-
-When @code{fringe-indicator-alist} has a buffer-local value, and there
-is no bitmap defined for a logical indicator, or the bitmap is
address@hidden, the corresponding value from the default value of
address@hidden is used.
-
-To completely hide a specific indicator, set the bitmap to @code{nil}.
address@hidden defvar
-
-Standard fringe bitmaps for indicators:
+  Each @var{bitmaps} value may be a list of symbols @code{(@var{left}
address@hidden address@hidden @var{right1}])}.  The @var{left} and
address@hidden symbols specify the bitmaps shown in the left and/or right
+fringe, for the specific indicator.  @var{left1} and @var{right1} are
+specific to the @code{bottom} and @code{top-bottom} indicators, and
+are used to indicate that the last text line has no final newline.
+Alternatively, @var{bitmaps} may be a single symbol which is used in
+both left and right fringes.
+
+  The standard symbols for fringe bitmaps are:
+
 @example
 left-arrow right-arrow up-arrow down-arrow
 left-curly-arrow right-curly-arrow
@@ -3428,6 +3422,16 @@
 empty-line question-mark
 @end example
 
address@hidden
+In addition, @code{nil} represents the empty bitmap (i.e.@: an
+indicator that is not shown).
+
+  When @code{fringe-indicator-alist} has a buffer-local value, and
+there is no bitmap defined for a logical indicator, or the bitmap is
address@hidden, the corresponding value from the default value of
address@hidden is used.
address@hidden defvar
+
 @node Fringe Cursors
 @subsection Fringe Cursors
 @cindex fringe cursors