From: Juanma Barranquero <lekktu@gmail.com>
Date: Wed, 28 Jul 2010 00:15:49 +0000 (+0200)
Subject: Document arguments passed to `read-buffer-function' (bug#5625).
X-Git-Tag: emacs-pretest-23.2.90~139^2~35^2~15
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b4f588fa4a41aaa4d90590f9c7ccf62beb1bfa06;p=emacs.git

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 --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
diff --git a/src/ChangeLog b/src/ChangeLog
index 78eb27f0814..08680c1f7f5 100644
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -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 --git a/src/minibuf.c b/src/minibuf.c
index 043eef13508..564346fd472 100644
--- a/src/minibuf.c
+++ b/src/minibuf.c
@@ -2131,7 +2131,8 @@ syms_of_minibuf ()
   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",