From: Chong Yidong <cyd@stupidchicken.com>
Date: Sat, 28 May 2011 18:48:41 +0000 (-0400)
Subject: * emacs-lisp/re-builder.el (re-builder): Improve doc (Bug#8286).
X-Git-Tag: emacs-pretest-24.0.90~104^2~618^2~119
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=23db196eea7d939897d95cb4b1d122bae1a63ce9;p=emacs.git

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

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index dba8f538d5e..5aeac2b9698 100644
--- 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 50a65eb6bbb..5ce18d020c9 100644
--- 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")