[Emacs-diffs] /srv/bzr/emacs/trunk r106817: Document Whitespace mode in manual, plus its use in Diff mode.

[Chong Yidong]

------------------------------------------------------------
revno: 106817
fixes bug(s): http://debbugs.gnu.org/10300
committer: Chong Yidong <address@hidden>
branch nick: trunk
timestamp: Sat 2012-01-07 16:55:43 +0800
message:
  Document Whitespace mode in manual, plus its use in Diff mode.
  
  * doc/emacs/display.texi (Useless Whitespace): Add Whitespace mode.
  
  * doc/emacs/files.texi (Diff Mode): Discuss use of Whitespace mode.
modified:
  doc/emacs/ChangeLog
  doc/emacs/display.texi
  doc/emacs/files.texi

=== modified file 'doc/emacs/ChangeLog'
--- a/doc/emacs/ChangeLog       2012-01-07 08:12:27 +0000
+++ b/doc/emacs/ChangeLog       2012-01-07 08:55:43 +0000
@@ -1,9 +1,11 @@
 2012-01-07  Chong Yidong  <address@hidden>
 
+       * display.texi (Useless Whitespace): Add Whitespace mode.
+
        * custom.texi (Hooks): Discuss how to disable minor modes.
 
        * files.texi (Diff Mode): Discuss diff-auto-refine-mode
-       (Bug#10309).
+       (Bug#10309).  Discuss use of Whitespace mode (Bug#10300).
 
        * trouble.texi (Lossage): Refer to Bugs node for problems.
        (DEL Does Not Delete): Don't use "usual erasure key" teminology.

=== modified file 'doc/emacs/display.texi'
--- a/doc/emacs/display.texi    2012-01-05 09:46:05 +0000
+++ b/doc/emacs/display.texi    2012-01-07 08:55:43 +0000
@@ -1062,6 +1062,56 @@
 default value of this variable, e.g.@: @code{(setq-default
 indicate-empty-lines t)}.
 
address@hidden Whitespace mode
address@hidden mode, Whitespace
address@hidden whitespace-mode
address@hidden whitespace-style
+  Whitespace mode is a buffer-local minor mode that lets you
+``visualize'' many kinds of whitespace in the buffer, by either
+drawing the whitespace characters with a special face or displaying
+them as special glyphs.  To toggle this mode, type @kbd{M-x
+whitespace-mode}.  The kinds of whitespace visualized are determined
+by the list variable @code{whitespace-style}.  Here is a partial list
+of possible elements (see the variable's documentation for the full
+list):
+
address@hidden @code
address@hidden face
+Enable all visualizations which use special faces.  This element has a
+special meaing: if it is absent from the list, none of the other
+visualizations take effect except @code{space-mark}, @code{tab-mark},
+and @code{newline-mark}.
+
address@hidden trailing
+Highlight trailing whitespace.
+
address@hidden tabs
+Highlight tab characters.
+
address@hidden spaces
+Highlight space and non-breaking space characters.
+
address@hidden lines
address@hidden whitespace-line-column
+Highlight lines longer than 80 lines.  To change the column limit,
+customize the variable @code{whitespace-line-column}.
+
address@hidden newline
+Highlight newlines.
+
address@hidden empty
+Highlight empty lines.
+
address@hidden space-mark
+Draw space and non-breaking characters with a special glyph.
+
address@hidden tab-mark
+Draw tab characters with a special glyph.
+
address@hidden newline-mark
+Draw newline characters with a special glyph.
address@hidden table
+
 @node Selective Display
 @section Selective Display
 @cindex selective display

=== modified file 'doc/emacs/files.texi'
--- a/doc/emacs/files.texi      2012-01-07 08:14:45 +0000
+++ b/doc/emacs/files.texi      2012-01-07 08:55:43 +0000
@@ -1463,13 +1463,14 @@
 operates on behalf of the current hunk's file, but gets the function
 name from the patch itself.  This is useful for making log entries for
 functions that are deleted by the patch.
-
address@hidden M-x diff-show-trailing-whitespaces RET
address@hidden diff-show-trailing-whitespaces
-Highlight trailing whitespace characters, except for those used by the
-patch syntax (@pxref{Useless Whitespace}).
 @end table
 
+  By default, Diff mode highlights trailing whitespace on modified
+lines, so that they are more obvious.  This is done by enabling
+Whitespace mode in the Diff buffer (@pxref{Useless Whitespace}).  Diff
+mode buffers are set up so that Whitespace mode avoids highlighting
+trailing whitespace occurring in the diff context.
+
 @node Misc File Ops
 @section Miscellaneous File Operations