GNU bug report logs - #6880
24.0.50; define-minor-mode doc string: no keymap var is defined

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 6880 in the body.
You can then email your comments to 6880 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; define-minor-mode doc string: no keymap var is defined
Date: Wed, 18 Aug 2010 10:08:22 -0700

The doc string of define-minor-mode says this:
 
"This function defines the associated control variable MODE, keymap
MODE-map, and toggle command MODE."
 
It does not seem to be true that it defines a keymap MODE-map.  And the
Elisp manual does not mention that it defines such a variable.
 
(define-minor-mode foo-mode "...")
 
C-h v foo-mode-map  ; No such variable was defined.
 
This bug goes back to the creation of define-minor-mode, in Emacs 21.
It has apparently never been the case that the keymap variable is
created, and it has always been the case that the doc says it is
created.
 
Or perhaps the bug is not only a doc bug?  Perhaps it is a bug that a
keymap variable is not created?  In that case, after fixing the code so
it creates the variable, the Elisp manual needs to be updated to mention
it.
 

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

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

From: Chong Yidong <cyd <at> stupidchicken.com>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 6880 <at> debbugs.gnu.org
Subject: Re: bug#6880: 24.0.50;
	define-minor-mode doc string: no keymap var is defined
Date: Sun, 22 Aug 2010 15:30:11 -0400

"Drew Adams" <drew.adams <at> oracle.com> writes:

> "This function defines the associated control variable MODE, keymap
> MODE-map, and toggle command MODE."
>
> It does not seem to be true that it defines a keymap MODE-map.  And the
> Elisp manual does not mention that it defines such a variable.

MODE-map is only created if you pass a list or a keymap as the KEYMAP
argument.  I've fixed the docstring and the lisp manual.  Thanks.

Previous Next

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