GNU bug report logs - #74999
[PATCH v2] Recommend `keymap-set' instead of `define-key' in emacs lisp intro

Previous Next

Package: emacs;

Reported by: Hong Xu <hong <at> topbug.net>

Date: Fri, 20 Dec 2024 21:45:02 UTC

Severity: wishlist

Tags: patch

Merged with 74983

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: Eli Zaretskii <eliz <at> gnu.org>
To: Hong Xu <hong <at> topbug.net>
Cc: 74999 <at> debbugs.gnu.org
Subject: bug#74999: [PATCH v4] Use `keymap*-set' over `global-set-key'/`define-key' in elisp intro
Date: Fri, 27 Dec 2024 09:44:39 +0200
> From: Hong Xu <hong <at> topbug.net>
> Date: Thu, 26 Dec 2024 14:05:01 -0800
> 
> On 2024-12-26 Thu 13:46 GMT-08, Hong Xu <hong <at> topbug.net> wrote:
> 
> > * doc/lispintro/emacs-lisp-intro.texi (Key Bindings): Since
> > `global-set-key' and `define-key' are considered legacy, we encourage
> > `keymap-global-set' and `keymap-set' now.
> > ---
> > <...>
> >
> > +@findex global-unset-key
> > +Historically, keys are unbound globally using a lower-function,
> > +@code{global-unset-key}, which is now considered legacy.  Its key
> > +binding format follows that of @code{global-set-key}.  The above key
> > +unbinding example can be rewritten as:
> > +@smallexample
> > +@group
> > +;;; Unbind 'C-x f'
> > +(global-unset-key "\C-xf")
> > +@end group
> > +@end smallexample
> > +
> 
> I'm thinking about dropping this paragraph, because `global-unset-key'
> isn't commonly seen, and there's no point to over fill an introduction
> with less used functions.  Please advice.

I wouldn't remove it.  This manual is an extended tutorial of the
Emacs Lisp language, so it doesn't necessarily include only the
frequently-used functions.  We must trust the author of this manual,
who was a great expert in teaching Emacs Lisp, that his decision to
include this function had a good reason.




This bug report was last modified 136 days ago.

Previous Next


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