GNU bug report logs - #36501
26.2; (elisp) `Defining Minor Modes'

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 36501 in the body.
You can then email your comments to 36501 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: 26.2; (elisp) `Defining Minor Modes'
Date: Thu, 4 Jul 2019 08:33:07 -0700 (PDT)

The examples defining `hungry-mode', and their descriptions, don't
seem completely correct.

Unless a minor mode is declared to be global, which `hungry-mode' is
not, I don't think it defines a user option.

But this doc says:

  It puts the variable 'hungry-mode' into custom group 'hunger'.

Does that happen?  Even if I define a `hunger' group before evaluating
those `define-minor-mode' sexps I don't see that `M-x customize-group'
gets you to variable `hungry-mode'.  But I didn't test much, e.g. with
different `defgroup' definitions for group `hungry'.

My guess is that (1) `:group 'hunger' should be removed from the
examples and (2) the doc should not say that variable `hungry-mode'
is put "into custom group `hunger'.  It should not give the impression
that var `hungry-mode' is a user option.

---

I also think it's not so important to show two full examples for the
buffer-local mode, and it might be good to show an example for a global
mode - perhaps even two: (1) using `define-minor-mode' and (2) using
`define-globalized-minor-mode'.


In GNU Emacs 26.2 (build 1, x86_64-w64-mingw32)
 of 2019-04-13
Repository revision: fd1b34bfba8f3f6298df47c8e10b61530426f749
Windowing system distributor `Microsoft Corp.', version 10.0.17134
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 36501 <at> debbugs.gnu.org
Subject: Re: bug#36501: 26.2; (elisp) `Defining Minor Modes'
Date: Mon, 08 Jul 2019 22:31:41 +0200

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

> But this doc says:
>
>   It puts the variable 'hungry-mode' into custom group 'hunger'.
>
> Does that happen?  Even if I define a `hunger' group before evaluating
> those `define-minor-mode' sexps I don't see that `M-x customize-group'
> gets you to variable `hungry-mode'.  But I didn't test much, e.g. with
> different `defgroup' definitions for group `hungry'.

I tested a bit, and I think you're right.

> My guess is that (1) `:group 'hunger' should be removed from the
> examples and (2) the doc should not say that variable `hungry-mode'
> is put "into custom group `hunger'.  It should not give the impression
> that var `hungry-mode' is a user option.

I've now done so.

> I also think it's not so important to show two full examples for the
> buffer-local mode, and it might be good to show an example for a global
> mode - perhaps even two: (1) using `define-minor-mode' and (2) using
> `define-globalized-minor-mode'.

The two examples are demonstrations of the short, non-explicit form and
the longer, explicit forms, so I think that's useful.

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