GNU bug report logs - #30530
26.0; Emacs manual: mention (1) user-reserved keys, (2) users can bind any keys

Previous Next

Package: emacs;

Reported by: Drew Adams <drew.adams <at> oracle.com>

Date: Mon, 19 Feb 2018 16:17:01 UTC

Severity: wishlist

Found in version 26.0

Done: Eli Zaretskii <eliz <at> gnu.org>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Drew Adams <drew.adams <at> oracle.com>
Subject: bug#30530: closed (Re: bug#30530: 26.0;	Emacs manual: mention (1)
 user-reserved keys, (2) users can bind any	keys)
Date: Sat, 24 Feb 2018 17:45:02 +0000
[Message part 1 (text/plain, inline)]
Your bug report

#30530: 26.0; Emacs manual: mention (1) user-reserved keys, (2) users can bind any keys

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 30530 <at> debbugs.gnu.org.

-- 
30530: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=30530
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 30530-done <at> debbugs.gnu.org, mail <at> nicolasgoaziou.fr
Subject: Re: bug#30530: 26.0;	Emacs manual: mention (1) user-reserved keys,
 (2) users can bind any	keys
Date: Sat, 24 Feb 2018 19:44:18 +0200
> Date: Sat, 24 Feb 2018 09:00:51 -0800 (PST)
> From: Drew Adams <drew.adams <at> oracle.com>
> Cc: 30530 <at> debbugs.gnu.org
> 
> The problem is that users do not necessarily have a good idea
> what keys they can bind (answer: any keys) and which keys
> Lisp libraries are likely to bind (answer: keys not reserved 
> or users).  Users have been known to ask about such things.

I added some text about the latter, although I seriously doubt that it
will be discoverable enough to make any difference.

As for the former, the manual is full of examples using all kinds of
keys in bindings (only one of them is from the reserved area, btw), so
it should be pretty clear that there are limitations on that.

[Message part 3 (message/rfc822, inline)]
From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 26.0; Emacs manual: mention (1) user-reserved keys, (2) users can
 bind any keys
Date: Mon, 19 Feb 2018 08:16:09 -0800 (PST)
Following up on the request by Nicolas Goaziou in bug #28263, please
consider adding some information about the keys that users can bind.

Please:

1. Say that Emacs and 3rd-party Lisp libraries often bind keys, but that
   some keys are specifically reserved, by convention, for users.  Point
   out which keys are reserved for users.

2. Make it clear that users can, in any case, bind ANY keys they want;
   they are not limited to binding user-reserved keys.  In particular,
   users can rebind keys that Emacs or some 3rd-party library has already
   bound.

3. State that after a user has bound a key, evaluating some Emacs code
   (including loading a Lisp library) might rebind that key if it is not
   reserved for users.  This is the reason some keys are reserved for
   users: to prevent the bother of some non-user code overriding user
   key bindings.

The keys reserved for users are currently specified only in the Elisp
manual (node `Key Binding Conventions').  Please consider adding a link
to that node from wherever the user-reserved keys will be called out in
the Emacs manual.

A likely location in the Emacs manual for such info would be somewhere
under node `Customizing Key Bindings'.

In GNU Emacs 26.0.91 (build 1, x86_64-w64-mingw32)
 of 2018-01-22
Repository revision: 752fba992b793a74d202c9cfc3e1a92fd458e748
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''



This bug report was last modified 7 years and 84 days ago.

Previous Next


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