bug#6528: 24.0.50; `read-buffer' doc string

bug#6528: 24.0.50; `read-buffer' doc string

[Drew Adams]

The doc string says:
 
 Optional third arg REQUIRE-MATCH determines whether non-existing
 buffer names are allowed.  It has the same meaning as the
 REQUIRE-MATCH argument of `confirm-after-completion'.
 
The last sentence is incorrect (meaningless): `confirm-after-completion'
is not a function, and it has no arguments.
 

In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
 of 2010-06-21 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.4) --no-opt --cflags -Ic:/xpm/include'
 

bug#6528: 24.0.50; `read-buffer' doc string

[Christoph]

The only other function in minibuf.c that has a REQUIRE-MATCH argument 
is completing-read (l.1722).

Since in read-buffer the function completing-read is called with the 
argument require-match (l.1237), I think the doc string should read like 
this:

"Optional third arg REQUIRE-MATCH determines whether non-existing
  buffer names are allowed.  It has the same meaning as the
  REQUIRE-MATCH argument of the `completing-read' function."

This patch will fix it accordingly:

=== modified file 'src/minibuf.c'
--- src/minibuf.c	2010-06-08 19:42:10 +0000
+++ src/minibuf.c	2010-06-29 02:59:05 +0000
@@ -1184,7 +1184,7 @@
   If DEF is a list of default values, return its first element.
  Optional third arg REQUIRE-MATCH determines whether non-existing
   buffer names are allowed.  It has the same meaning as the
- REQUIRE-MATCH argument of `confirm-after-completion'.
+ REQUIRE-MATCH argument of the `completing-read' function.
  The argument PROMPT should be a string ending with a colon and a space.
  If `read-buffer-completion-ignore-case' is non-nil, completion ignores
  case while reading the buffer name.


Christoph

bug#6528: 24.0.50; `read-buffer' doc string

[Drew Adams]

> Since in read-buffer the function completing-read is called with the 
> argument require-match (l.1237), I think the doc string 
> should read like this:
> 
> "Optional third arg REQUIRE-MATCH determines whether non-existing
>   buffer names are allowed.  It has the same meaning as the
>   REQUIRE-MATCH argument of the `completing-read' function."

I imagine that's right. Hopefully someone who knows will confirm. Thx.

bug#6528: 24.0.50; `read-buffer' doc string

[Juanma Barranquero]

On Tue, Jun 29, 2010 at 08:28, Drew Adams <drew.adams@oracle.com> wrote:

> I imagine that's right. Hopefully someone who knows will confirm. Thx.

It seems obviously correct, so I've committed it to emacs-23.

    Juanma