# HG changeset patch
# User Juanma Barranquero <lekktu@gmail.com>
# Date 1280276149 -7200
# Node ID ea5dcd4a779aa78932b7f1fffa7244e0aced571b
# Parent  58882317bf04765c137ec61a55378065a8552cb6
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.

diff -r 58882317bf04 -r ea5dcd4a779a doc/lispref/ChangeLog
--- a/doc/lispref/ChangeLog	Tue Jul 27 15:50:01 2010 -0400
+++ b/doc/lispref/ChangeLog	Wed Jul 28 02:15:49 2010 +0200
@@ -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 -r 58882317bf04 -r ea5dcd4a779a doc/lispref/minibuf.texi
--- a/doc/lispref/minibuf.texi	Tue Jul 27 15:50:01 2010 -0400
+++ b/doc/lispref/minibuf.texi	Wed Jul 28 02:15:49 2010 +0200
@@ -1222,10 +1222,11 @@
 @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
diff -r 58882317bf04 -r ea5dcd4a779a src/ChangeLog
--- a/src/ChangeLog	Tue Jul 27 15:50:01 2010 -0400
+++ b/src/ChangeLog	Wed Jul 28 02:15:49 2010 +0200
@@ -1,3 +1,8 @@
+2010-07-28  Juanma Barranquero  <lekktu@gmail.com>
+
+	* minibuf.c (syms_of_minibuf) <read-buffer-function>:
+	Doc fix (bug#5625).
+
 2010-07-27  Ken Brown  <kbrown@cornell.edu>
 
 	* dired.c (DIRENTRY_NONEMPTY) [cygwin]: Use d_ino instead of
diff -r 58882317bf04 -r ea5dcd4a779a src/minibuf.c
--- a/src/minibuf.c	Tue Jul 27 15:50:01 2010 -0400
+++ b/src/minibuf.c	Wed Jul 28 02:15:49 2010 +0200
@@ -2131,7 +2131,8 @@
   staticpro (&Qread_expression_history);
 
   DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function,
-	       doc: /* If this is non-nil, `read-buffer' does its work by calling this function.  */);
+	       doc: /* If this is non-nil, `read-buffer' does its work by calling this function.
+The function is called with the arguments passed to `read-buffer'.  */);
   Vread_buffer_function = Qnil;
 
   DEFVAR_BOOL ("read-buffer-completion-ignore-case",