* emacs-lisp/re-builder.el (re-builder): Improve doc (Bug#8286).

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index dba8f538d5e67a19dbc317099b7c88a343f14acc..5aeac2b9698c456a9db35aa83818989815b07660 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,7 @@
+2011-05-28  Chong Yidong  <cyd@stupidchicken.com>
+
+       * emacs-lisp/re-builder.el (re-builder): Improve doc (Bug#8286).
+
 2011-05-28  Dima Kogan  <dkogan@cds.caltech.edu>  (tiny change)
 
        * progmodes/hideshow.el (hs-looking-at-block-start-p): New fun.

diff --git a/lisp/emacs-lisp/re-builder.el b/lisp/emacs-lisp/re-builder.el
index 50a65eb6bbb55531eb2543fb458d2746653b84a8..5ce18d020c96abfe05f7b7f2d95403366d5ced1c 100644 (file)
--- a/lisp/emacs-lisp/re-builder.el
+++ b/lisp/emacs-lisp/re-builder.el
@@ -351,9 +351,14 @@ Except for Lisp syntax this is the same as `reb-regexp'.")
 
 ;;;###autoload
 (defun re-builder ()
-  "Construct a regexp interactively."
-  (interactive)
+  "Construct a regexp interactively.
+This command makes the current buffer the \"target\" buffer of
+the regexp builder.  It displays a buffer named \"*RE-Builder*\"
+in another window, initially containing an empty regexp.
 
+As you edit the regexp in the \"*RE-Builder*\" buffer, the
+matching parts of the target buffer will be highlighted."
+  (interactive)
   (if (and (string= (buffer-name) reb-buffer)
           (reb-mode-buffer-p))
       (message "Already in the RE Builder")