GNU bug report logs - #11299
24.1.50; Make `customize-mode' work for minor modes too, or define `customize-minor-mode'

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 11299 in the body.
You can then email your comments to 11299 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.1.50; Make `customize-mode' work for minor modes too, or define
	`customize-minor-mode'
Date: Sat, 21 Apr 2012 09:16:30 -0700

1. First, a doc quibble and a question about the status of this command.
`(elisp) Derived Modes' says, "Only the (still experimental and
unadvertised) command `customize-mode' currently uses this."
 
It has said this since at least Emacs 22.  If it was an experiment (how
so? no explanation anywhere, AFAICT), presumably it is over now?  Or at
least explain in what way it is experimental.  Does it have problems?
If so what?  It does not help users to characterize something as
"experimental" if you do not describe the experiment or the associated
questions/problems.
 
And `customize-mode' is of course not at all "unadvertised", since it is
documented, including here, in this part of the manual.  This kind of
writing, characterizing something as experimental or unadvertised does
not belong in the manual.  And it only becomes more inappropriate with
time and neglect.
 

2. AFAICT, there is nothing in the definition or use of `customize-mode'
that necessarily limits it to major modes.  The only thing that limits
it this way is that `major-mode' is hard-coded in its definition.
 
Even the use of `custom-group-of-mode' in the definition applies equally
to minor modes, IIUC.  Likewise, the use of `completion-regexp-list'
with "-mode\\'" applies to minor modes as well.
 
So please release it from its limitation to major modes.  Minor modes
can have defcustoms and deffaces and defgroups too.
 
It is OK for the default to be the current major mode, but the use of a
prefix arg (completion for a mode name) should at least allow for minor
modes as well as major modes.
 

In GNU Emacs 24.1.50.1 (i386-mingw-nt5.1.2600)
 of 2012-04-19 on MARVIN
Bzr revision: 107968 monnier <at> iro.umontreal.ca-20120419220225-gijdcbfxuiqy5dhb
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.6) --no-opt --enable-checking --cflags
 -ID:/devel/emacs/libs/libXpm-3.5.8/include
 -ID:/devel/emacs/libs/libXpm-3.5.8/src
 -ID:/devel/emacs/libs/libpng-dev_1.4.3-1/include
 -ID:/devel/emacs/libs/zlib-dev_1.2.5-2/include
 -ID:/devel/emacs/libs/giflib-4.1.4-1/include
 -ID:/devel/emacs/libs/jpeg-6b-4/include
 -ID:/devel/emacs/libs/tiff-3.8.2-1/include
 -ID:/devel/emacs/libs/gnutls-3.0.9/include
 -ID:/devel/emacs/libs/libiconv-1.13.1-1-dev/include
 -ID:/devel/emacs/libs/libxml2-2.7.8/include/libxml2'
 

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

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <11299 <at> debbugs.gnu.org>
Subject: RE: bug#11299: 24.1.50;
	Make `customize-mode' work for minor modes too, or
	define`customize-minor-mode'
Date: Sat, 21 Apr 2012 10:50:08 -0700

E.g., something like this:

(defun customize-mode (mode)
    "Customize options related to a major or minor mode.
By default the current major is used.
With a prefix argument or if the current major mode has no known group,
you are prompted for the MODE to customize."
    (interactive
     (list
      (let ((completion-regexp-list  '("-mode\\'"))
            (group                   (custom-group-of-mode major-mode)))
        (if (and group  (not current-prefix-arg))
            major-mode
          (intern (completing-read
                    "Mode: " obarray 'custom-group-of-mode
                    t nil nil (and group  (symbol-name major-mode))))))))
    (customize-group (custom-group-of-mode mode)))

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

From: Noam Postavsky <npostavs <at> users.sourceforge.net>
To: 11299 <at> debbugs.gnu.org
Cc: Drew Adams <drew.adams <at> oracle.com>
Subject: RE: bug#11299: 24.1.50; Make `customize-mode' work for minor modes
 too, or define`customize-minor-mode'
Date: Fri, 24 Jun 2016 23:23:34 -0400

[Message part 1 (text/plain, inline)]

tag 11299 + patch
quit

> `(elisp) Derived Modes' says, "Only the (still experimental and
> unadvertised) command `customize-mode' currently uses this."
>
> It has said this since at least Emacs 22.

Indeed that seems long enough to declare it non-experimental. So I
propose removing that phrase and just say "The command
`customize-mode' uses this", as in the current docstring of
`define-derived-modes'. Any objections?

> It is OK for the default to be the current major mode, but the use
> of a prefix arg (completion for a mode name) should at least allow
> for minor modes as well as major modes.

AFAICT it always allowed entering any mode with a prefix argument,
it's just a matter of updating prompt and docstring (cf
http://debbugs.gnu.org/cgi/bugreport.cgi?bug=23649).

[0002-Don-t-describe-customize-mode-as-experimental.patch (text/x-patch, attachment)]

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Noam Postavsky <npostavs <at> users.sourceforge.net>
Cc: 11299 <at> debbugs.gnu.org
Subject: Re: bug#11299: 24.1.50;
 Make `customize-mode' work for minor modes too, or
 define`customize-minor-mode'
Date: Sat, 25 Jun 2016 11:04:36 +0300

> From: Noam Postavsky <npostavs <at> users.sourceforge.net>
> Date: Fri, 24 Jun 2016 23:23:34 -0400
> 
> > `(elisp) Derived Modes' says, "Only the (still experimental and
> > unadvertised) command `customize-mode' currently uses this."
> >
> > It has said this since at least Emacs 22.
> 
> Indeed that seems long enough to declare it non-experimental. So I
> propose removing that phrase and just say "The command
> `customize-mode' uses this", as in the current docstring of
> `define-derived-modes'. Any objections?

No, looks good.

Thanks.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Noam Postavsky <npostavs <at> users.sourceforge.net>
Cc: 11299 <at> debbugs.gnu.org
Subject: Re: bug#11299: 24.1.50;
 Make `customize-mode' work for minor modes too, or
 define`customize-minor-mode'
Date: Sat, 25 Jun 2016 11:04:58 +0300

> From: Noam Postavsky <npostavs <at> users.sourceforge.net>
> Date: Fri, 24 Jun 2016 23:23:34 -0400
> 
> > `(elisp) Derived Modes' says, "Only the (still experimental and
> > unadvertised) command `customize-mode' currently uses this."
> >
> > It has said this since at least Emacs 22.
> 
> Indeed that seems long enough to declare it non-experimental. So I
> propose removing that phrase and just say "The command
> `customize-mode' uses this", as in the current docstring of
> `define-derived-modes'. Any objections?

No, looks good.  Please push to the release branch.

Thanks.

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

From: Noam Postavsky <npostavs <at> users.sourceforge.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 11299-done <at> debbugs.gnu.org
Subject: Re: bug#11299: 24.1.50; Make `customize-mode' work for minor modes
 too, or define`customize-minor-mode'
Date: Sat, 25 Jun 2016 13:35:19 -0400

Version: 25.1

Pushed to emacs-25 f2536958ec711b50a0cf8714defb921193ea8ae4

Previous Next

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