GNU bug report logs - #6528
24.0.50; `read-buffer' doc string

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 6528 in the body.
You can then email your comments to 6528 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: 24.0.50; `read-buffer' doc string
Date: Mon, 28 Jun 2010 08:40:19 -0700

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'
 

Message #8 received at 6528 <at> debbugs.gnu.org (full text, mbox):

From: Christoph <cschol2112 <at> googlemail.com>
To: 6528 <at> debbugs.gnu.org
Cc: drew.adams <at> oracle.com
Subject: Re: 24.0.50; `read-buffer' doc string
Date: Mon, 28 Jun 2010 21:03:30 -0600

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

Message #11 received at 6528 <at> debbugs.gnu.org (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Christoph'" <cschol2112 <at> googlemail.com>, <6528 <at> debbugs.gnu.org>
Subject: RE: 24.0.50; `read-buffer' doc string
Date: Mon, 28 Jun 2010 23:28:49 -0700

> 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.

Message #18 received at 6528-done <at> debbugs.gnu.org (full text, mbox):

From: Juanma Barranquero <lekktu <at> gmail.com>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: Christoph <cschol2112 <at> googlemail.com>, 6528-done <at> debbugs.gnu.org
Subject: Re: bug#6528: 24.0.50; `read-buffer' doc string
Date: Mon, 26 Jul 2010 01:57:49 +0200

On Tue, Jun 29, 2010 at 08:28, Drew Adams <drew.adams <at> 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

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.