Document arguments passed to `read-buffer-function' (bug#5625).

* doc/lispref/minibuf.texi (High-Level Completion): Document args of
  `read-buffer-function'.
* src/minibuf.c (syms_of_minibuf) <read-buffer-function>: Doc fix.

2 files changed, 10 insertions, 4 deletions

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 7acfeccea04..596cf8e70f9 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,8 @@
+2010-07-28  Juanma Barranquero  <lekktu@gmail.com>
+
+        * minibuf.texi (High-Level Completion): Document args of
+        `read-buffer-function' (bug#5625).
+
 2010-07-27  Juanma Barranquero  <lekktu@gmail.com>
 
         * modes.texi (Defining Minor Modes): Use C-delete in examples,
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi
index 3588704b054..9bc6be432ae 100644
--- a/doc/lispref/minibuf.texi
+++ b/doc/lispref/minibuf.texi
@@ -1222,10 +1222,11 @@ Buffer name (default foo): @point{}
 @end defun
 
 @defopt read-buffer-function
-This variable specifies how to read buffer names.  For example, if you
-set this variable to @code{iswitchb-read-buffer}, all Emacs commands
-that call @code{read-buffer} to read a buffer name will actually use the
-@code{iswitchb} package to read it.
+This variable specifies how to read buffer names.  The function is
+called with the arguments passed to @code{read-buffer}.  For example,
+if you set this variable to @code{iswitchb-read-buffer}, all Emacs
+commands that call @code{read-buffer} to read a buffer name will
+actually use the @code{iswitchb} package to read it.
 @end defopt
 
 @defopt read-buffer-completion-ignore-case