* buffer.c (word_wrap): Doc fix.

diff --git a/src/ChangeLog b/src/ChangeLog
index 7a9ab1757eb9ef1a35b3b9e70efc4147334190fe..7ea9ad8f3e31260565f70a8fdcc5d5b0833ae55e 100644 (file)
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,7 @@
+2012-06-06  Chong Yidong  <cyd@gnu.org>
+
+       * buffer.c (word_wrap): Doc fix.
+
 2012-06-04  Paul Eggert  <eggert@cs.ucla.edu>
 
        * xdisp.c (note_mode_line_or_margin_highlight): Pacify gcc -Wall.

diff --git a/src/buffer.c b/src/buffer.c
index 386d9a78153c9bc82a32e11849c0a70bc7c3f21a..504d477494b688b7e59068e8a29d36eaa23293af 100644 (file)
--- a/src/buffer.c
+++ b/src/buffer.c
@@ -5522,7 +5522,13 @@ This variable has no effect if long lines are truncated (see
 `truncate-lines' and `truncate-partial-width-windows').  If you use
 word-wrapping, you might want to reduce the value of
 `truncate-partial-width-windows', since wrapping can make text readable
-in narrower windows.  */);
+in narrower windows.
+
+Instead of setting this variable directly, most users should use
+Visual Line mode .  Visual Line mode, when enabled, sets `word-wrap'
+to t, and additionally redefines simple editing commands to act on
+visual lines rather than logical lines.  See the documentation of
+`visual-line-mode'.  */);
 
   DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer, directory),
                     make_number (Lisp_String),