GNU bug report logs - #6337
24.0.50; doc of define-minor-mode incomplete wrt mode hooks

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 6337 in the body.
You can then email your comments to 6337 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; doc of define-minor-mode incomplete wrt mode hooks
Date: Wed, 2 Jun 2010 17:03:30 -0700

The doc for `define-minor-mode' is incomplete regarding the mode
hooks, and it has apparently been like this since the beginning
(Emacs 21).
 
The doc (doc string and Elisp manual) speaks about the MODE-hook, where
MODE is the name of the minor mode.  But it does not mention that there
is also a `MODE-on-hook' and a `MODE-off-hook'.  That is, if you define
those hook variables they to will be processed by the mode command.

The exact behavior should be defined: The MODE-hook, if any, is run
first, then the MODE-on-hook or MODE-off-hook is run, depending on
whether the mode is being turned on or off.
 

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

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

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 6337 <at> debbugs.gnu.org
Subject: Re: bug#6337: 24.0.50;
	doc of define-minor-mode incomplete wrt mode hooks
Date: Wed, 02 Jun 2010 21:56:30 -0400

> The doc (doc string and Elisp manual) speaks about the MODE-hook, where
> MODE is the name of the minor mode.  But it does not mention that there
> is also a `MODE-on-hook' and a `MODE-off-hook'.  That is, if you define
> those hook variables they to will be processed by the mode command.

They're only supported for historical reasons.  We could/should probably
get rid of them.


        Stefan

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

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 6337 <at> debbugs.gnu.org, Drew Adams <drew.adams <at> oracle.com>
Subject: Re: bug#6337: 24.0.50;
	doc of define-minor-mode incomplete wrt mode hooks
Date: Thu, 14 Jul 2011 00:10:58 +0200

Stefan Monnier <monnier <at> iro.umontreal.ca> writes:

>> The doc (doc string and Elisp manual) speaks about the MODE-hook, where
>> MODE is the name of the minor mode.  But it does not mention that there
>> is also a `MODE-on-hook' and a `MODE-off-hook'.  That is, if you define
>> those hook variables they to will be processed by the mode command.
>
> They're only supported for historical reasons.  We could/should probably
> get rid of them.

This doesn't seem like a bug, then, so I'm closing this report.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Previous Next

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