GNU bug report logs - #9117
24.0.50; Document menu keyword `:selected'

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 9117 in the body.
You can then email your comments to 9117 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; Document menu keyword `:selected'
Date: Mon, 18 Jul 2011 09:23:41 -0700

Please document the menu keyword :selected.  Presumably the place for
this would be: `(elisp) Extended Menu Items', along with :visible,
:enable, etc.
 
In particular, document its relation with keywords such as :visible and
:enable - e.g., if not visible then :selected is not evaluated (or
whatever is the truth).
 
For example, I see code such as this in a 3rd-party library, and I
wonder what happens if `ls-lisp-dirs-first' is undefined.  The :visible
sexp here is protected OK (by `ls-lisp-var-p'), but if :selected is
eval'd even when :visible is nil then this would presumably raise an
error.
 
["Ignore Case" dired-sort-menu-toggle-ignore-case :style toggle
    :selected ls-lisp-ignore-case :active t
    :help "Ignore case in alphanumeric sorting"
    ;; supported only by (Emacs 21) ls-lisp library and local dired:
    :visible (ls-lisp-var-p 'ls-lisp-ignore-case)]

["Dirs First" dired-sort-menu-toggle-dirs-first :style toggle
    :selected ls-lisp-dirs-first :active t
    :help "List subdirectories first [last if reversed]"
    ;; supported only by (Emacs 21) ls-lisp library and local dired:
    :visible (ls-lisp-var-p 'ls-lisp-dirs-first)]
 
Anyway, the point is that there seems to be no documentation at all for
:selected, even though it is used in lots of core Lisp code and in
3rd-party code.

In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
 of 2011-07-11 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.5) --no-opt --cflags
-Ic:/build/include'
 

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

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 9117 <at> debbugs.gnu.org
Subject: Re: 24.0.50; Document menu keyword `:selected'
Date: Sun, 11 Sep 2011 05:14:20 +0200

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

> For example, I see code such as this in a 3rd-party library, and I
> wonder what happens if `ls-lisp-dirs-first' is undefined.  The :visible
> sexp here is protected OK (by `ls-lisp-var-p'), but if :selected is
> eval'd even when :visible is nil then this would presumably raise an
> error.
>
> ["Ignore Case" dired-sort-menu-toggle-ignore-case :style toggle
>     :selected ls-lisp-ignore-case :active t
>     :help "Ignore case in alphanumeric sorting"
>     ;; supported only by (Emacs 21) ls-lisp library and local dired:
>     :visible (ls-lisp-var-p 'ls-lisp-ignore-case)]

:selected is, as far as I can tell, an `easy-menu-define' thing, and is
documented there.  I'm not sure `define-key' supports it at all --
anybody know?

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

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 9117 <at> debbugs.gnu.org
Subject: Re: bug#9117: 24.0.50; Document menu keyword `:selected'
Date: Thu, 28 Apr 2016 13:12:22 +0200

Lars Magne Ingebrigtsen <larsi <at> gnus.org> writes:

> "Drew Adams" <drew.adams <at> oracle.com> writes:
>
>> For example, I see code such as this in a 3rd-party library, and I
>> wonder what happens if `ls-lisp-dirs-first' is undefined.  The :visible
>> sexp here is protected OK (by `ls-lisp-var-p'), but if :selected is
>> eval'd even when :visible is nil then this would presumably raise an
>> error.
>>
>> ["Ignore Case" dired-sort-menu-toggle-ignore-case :style toggle
>>     :selected ls-lisp-ignore-case :active t
>>     :help "Ignore case in alphanumeric sorting"
>>     ;; supported only by (Emacs 21) ls-lisp library and local dired:
>>     :visible (ls-lisp-var-p 'ls-lisp-ignore-case)]
>
> :selected is, as far as I can tell, an `easy-menu-define' thing, and is
> documented there.  I'm not sure `define-key' supports it at all --
> anybody know?

Doesn't seem like it.  `easy-menu-define' documents :selected, so I
don't think there's anything to fix here.

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