[Emacs-diffs] /srv/bzr/emacs/emacs-23 r99948: Document arguments passed to `read-buffer-function' (bug#5625).

[Juanma Barranquero]

------------------------------------------------------------
revno: 99948
committer: Juanma Barranquero <address@hidden>
branch nick: emacs-23
timestamp: Wed 2010-07-28 02:15:49 +0200
message:
  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.
modified:
  doc/lispref/ChangeLog
  doc/lispref/minibuf.texi
  src/ChangeLog
  src/minibuf.c

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2010-07-27 01:37:23 +0000
+++ b/doc/lispref/ChangeLog     2010-07-28 00:15:49 +0000
@@ -1,3 +1,8 @@
+2010-07-28  Juanma Barranquero  <address@hidden>
+
+       * minibuf.texi (High-Level Completion): Document args of
+       `read-buffer-function' (bug#5625).
+
 2010-07-27  Juanma Barranquero  <address@hidden>
 
        * modes.texi (Defining Minor Modes): Use C-delete in examples,

=== modified file 'doc/lispref/minibuf.texi'
--- a/doc/lispref/minibuf.texi  2010-06-23 03:36:56 +0000
+++ b/doc/lispref/minibuf.texi  2010-07-28 00:15:49 +0000
@@ -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
address@hidden 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

=== modified file 'src/ChangeLog'
--- a/src/ChangeLog     2010-07-27 11:10:48 +0000
+++ b/src/ChangeLog     2010-07-28 00:15:49 +0000
@@ -1,3 +1,8 @@
+2010-07-28  Juanma Barranquero  <address@hidden>
+
+       * minibuf.c (syms_of_minibuf) <read-buffer-function>:
+       Doc fix (bug#5625).
+
 2010-07-27  Ken Brown  <address@hidden>
 
        * dired.c (DIRENTRY_NONEMPTY) [cygwin]: Use d_ino instead of

=== modified file 'src/minibuf.c'
--- a/src/minibuf.c     2010-07-25 23:56:56 +0000
+++ b/src/minibuf.c     2010-07-28 00:15:49 +0000
@@ -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",