aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2016-01-02 14:06:02 +0200
committerEli Zaretskii2016-01-02 14:06:02 +0200
commit964bea7da5283a6c1ca2d7c6ee8a9d07d4951e69 (patch)
tree44d557cbcf1665625569243cde8f71bca15b880c
parentcd68f47e4fddaa891a978b4ac55cbf323850dfd9 (diff)
downloademacs-964bea7da5283a6c1ca2d7c6ee8a9d07d4951e69.tar.gz
emacs-964bea7da5283a6c1ca2d7c6ee8a9d07d4951e69.zip
Document new features of Whitespace mode
* doc/emacs/display.texi (Useless Whitespace): Document 'whitespace-toggle-options' and the new 'big-indent' style. Document 'whitespace-big-indent-regexp'. Document the Global Whitespace mode.
-rw-r--r--doc/emacs/display.texi18
-rw-r--r--etc/NEWS8
2 files changed, 22 insertions, 4 deletions
diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi
index 38e7a90bf44..1b75a15427c 100644
--- a/doc/emacs/display.texi
+++ b/doc/emacs/display.texi
@@ -1164,12 +1164,15 @@ indicate-empty-lines t)}.
1164@cindex mode, Whitespace 1164@cindex mode, Whitespace
1165@findex whitespace-mode 1165@findex whitespace-mode
1166@vindex whitespace-style 1166@vindex whitespace-style
1167@findex whitespace-toggle-options
1167 Whitespace mode is a buffer-local minor mode that lets you 1168 Whitespace mode is a buffer-local minor mode that lets you
1168visualize many kinds of whitespace in the buffer, by either 1169visualize many kinds of whitespace in the buffer, by either
1169drawing the whitespace characters with a special face or displaying 1170drawing the whitespace characters with a special face or displaying
1170them as special glyphs. To toggle this mode, type @kbd{M-x 1171them as special glyphs. To toggle this mode, type @kbd{M-x
1171whitespace-mode}. The kinds of whitespace visualized are determined 1172whitespace-mode}. The kinds of whitespace visualized are determined
1172by the list variable @code{whitespace-style}. Here is a partial list 1173by the list variable @code{whitespace-style}. Individual elements in
1174that list can be toggled on or off in the current buffer by typing
1175@w{@kbd{M-x whitespace-toggle-options}}. Here is a partial list
1173of possible elements (see the variable's documentation for the full 1176of possible elements (see the variable's documentation for the full
1174list): 1177list):
1175 1178
@@ -1200,6 +1203,13 @@ Highlight newlines.
1200@item empty 1203@item empty
1201Highlight empty lines. 1204Highlight empty lines.
1202 1205
1206@item big-indent
1207@vindex whitespace-big-indent-regexp
1208Highlight too-deep indentation. By default any sequence of at least 4
1209consecutive TAB characters or 32 consecutive SPC characters is
1210highlighted. To change that, customize the regular expression
1211@code{whitespace-big-indent-regexp}.
1212
1203@item space-mark 1213@item space-mark
1204Draw space and non-breaking characters with a special glyph. 1214Draw space and non-breaking characters with a special glyph.
1205 1215
@@ -1210,6 +1220,12 @@ Draw tab characters with a special glyph.
1210Draw newline characters with a special glyph. 1220Draw newline characters with a special glyph.
1211@end table 1221@end table
1212 1222
1223@findex global-whitespace-toggle-options
1224@findex global-whitespace-mode
1225Global Whitespace mode is a global minor mode that lets you visualize
1226whitespace in all buffers. To toggle individual features, use
1227@kbd{M-x global-whitespace-toggle-options}.
1228
1213@node Selective Display 1229@node Selective Display
1214@section Selective Display 1230@section Selective Display
1215@cindex selective display 1231@cindex selective display
diff --git a/etc/NEWS b/etc/NEWS
index c20afaf7d3f..1880e6df4da 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -919,9 +919,11 @@ use PDF instead of DVI.
919`prettify-symbols-mode' in a tex-mode buffer, \alpha ... \omega, and 919`prettify-symbols-mode' in a tex-mode buffer, \alpha ... \omega, and
920many other math macros are displayed using unicode characters. 920many other math macros are displayed using unicode characters.
921 921
922** whitespace-mode: new 'big-indent style highlighting too much indentation. 922+++
923By default, 32 spaces and four TABs are considered to be too much but 923** New `big-indent' style in `whitespace-mode' highlights deep indentation.
924`whitespace-big-indent-regexp' can be configured to change that. 924By default, 32 consecutive spaces or four consecutive TABs are
925considered to be too deep, but the new variable
926`whitespace-big-indent-regexp' can be customized to change that.
925 927
926** tildify: `tildify-space-string', `tildify-pattern', and 928** tildify: `tildify-space-string', `tildify-pattern', and
927`tildify-foreach-region-function' variables added making 929`tildify-foreach-region-function' variables added making