bug#5149: 23.1; doc string of `minibuffer-with-setup-hook'

bug#5149: 23.1; doc string of `minibuffer-with-setup-hook'

[Drew Adams]

Doc string:
 
"Add FUN to `minibuffer-setup-hook' while executing BODY.
BODY should use the minibuffer at most once.
Recursive uses of the minibuffer will not be affected."
 
Please state explicitly that FUN is removed from
`minibuffer-setup-hook' when the minibuffer is exited.
 
The use of "while executing BODY" suggests that somewhat, but it is
not clear enough. It says it is _added_ while executing, but it
doesn't say that it is removed.
 
In fact, FUN is not really added to hook `minibuffer-setup-hook'.
Someone or some code looking for FUN on the hook will never find it
there.
 
Instead, a proxy function that invokes FUN is added to the hook. So it
would be more accurate to say that FUN is added, "in effect", or
something like that.
 

In GNU Emacs 23.1.1 (i386-mingw-nt5.1.2600)
 of 2009-07-29 on SOFT-MJASON
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.4)'
 

bug#5149: marked as done (23.1; doc string of `minibuffer-with-setup-hook')

[Emacs bug Tracking System]

[-- Attachment #1: Type: text/plain, Size: 849 bytes --]

Your message dated Fri, 01 Jan 2010 15:04:56 -0500
with message-id <873a2pzj4n.fsf@stupidchicken.com>
and subject line Re: 23.1; doc string of `minibuffer-with-setup-hook'
has caused the Emacs bug report #5149,
regarding 23.1; doc string of `minibuffer-with-setup-hook'
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact bug-gnu-emacs@gnu.org
immediately.)


-- 
5149: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=5149
Emacs Bug Tracking System
Contact bug-gnu-emacs@gnu.org with problems

[-- Attachment #2: Type: message/rfc822, Size: 3802 bytes --]

From: "Drew Adams" <drew.adams@oracle.com>
To: <bug-gnu-emacs@gnu.org>
Subject: 23.1; doc string of `minibuffer-with-setup-hook'
Date: Mon, 7 Dec 2009 10:24:49 -0800
Message-ID: <6D254E10A5E142F7ACA42DD7BF50946E@us.oracle.com>

Doc string:
 
"Add FUN to `minibuffer-setup-hook' while executing BODY.
BODY should use the minibuffer at most once.
Recursive uses of the minibuffer will not be affected."
 
Please state explicitly that FUN is removed from
`minibuffer-setup-hook' when the minibuffer is exited.
 
The use of "while executing BODY" suggests that somewhat, but it is
not clear enough. It says it is _added_ while executing, but it
doesn't say that it is removed.
 
In fact, FUN is not really added to hook `minibuffer-setup-hook'.
Someone or some code looking for FUN on the hook will never find it
there.
 
Instead, a proxy function that invokes FUN is added to the hook. So it
would be more accurate to say that FUN is added, "in effect", or
something like that.
 

In GNU Emacs 23.1.1 (i386-mingw-nt5.1.2600)
 of 2009-07-29 on SOFT-MJASON
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.4)'
 




[-- Attachment #3: Type: message/rfc822, Size: 2710 bytes --]

From: Chong Yidong <cyd@stupidchicken.com>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: 5149-done@debbugs.gnu.org
Subject: Re: 23.1; doc string of `minibuffer-with-setup-hook'
Date: Fri, 01 Jan 2010 15:04:56 -0500
Message-ID: <873a2pzj4n.fsf@stupidchicken.com>

> Please state explicitly that FUN is removed from `minibuffer-setup-hook'
> when the minibuffer is exited.  The use of "while executing BODY"
> suggests that somewhat, but it is not clear enough. It says it is
> _added_ while executing, but it doesn't say that it is removed.

> In fact, FUN is not really added to hook `minibuffer-setup-hook'.
> Someone or some code looking for FUN on the hook will never find it
> there.  Instead, a proxy function that invokes FUN is added to the
> hook. So it would be more accurate to say that FUN is added, "in
> effect", or something like that.

Fixed, thanks.