From: Eli Zaretskii <eliz@gnu.org>
To: Hong Xu <hong@topbug.net>
Cc: 74999@debbugs.gnu.org
Subject: bug#74999: [PATCH v3] Recommend `keymap-set' instead of `define-key' in emacs lisp intro
Date: Thu, 26 Dec 2024 10:20:11 +0200 [thread overview]
Message-ID: <86ed1uzwhw.fsf@gnu.org> (raw)
In-Reply-To: <20241221080552.259664-1-hong@topbug.net> (message from Hong Xu on Sat, 21 Dec 2024 00:03:54 -0800)
> From: Hong Xu <hong@topbug.net>
> Date: Sat, 21 Dec 2024 00:03:54 -0800
>
> * Since `define-key' is considered legacy and we encourage `keymap-set'
> now.
> ---
> doc/lispintro/emacs-lisp-intro.texi | 25 ++++++++++++++++++-------
> 1 file changed, 18 insertions(+), 7 deletions(-)
Thanks. I tried to install this, but the git-commit hook rejected the
commit because Subject line is too long:
Line longer than 78 characters in commit message
Commit aborted; please see the file CONTRIBUTE
Please format the patch using "git format-patch", and please commit
the patch locally before you do so (assuming you have the hooks in
your local clone), to make sure these problems are corrected before
you send the patch here.
More generally, global-set-key, discussed earlier in this section, is
also obsolete, and we nowadays prefer keymap-global-set instead. So,
if we want to modernize this part of the Emacs Lisp Intro manual, I
think we should replace all the key-binding examples and the
surrounding text in the manual to use the new keymap-* functions. It
makes little sense to replace only define-key and leave the rest as
they were.
Would you like to submit a patch that takes care of these issues in a
more thorough manner?
> +While you are encouraged to use @code{keymap-set}, you likely would
> +encounter @code{define-key} in various places. Historically, keymaps
> +are bound using a lower-level function, @code{define-key}, which
> +is now considered legacy.
These two sentences should be in reverse order: first tell that
historically we used define-key, then say that the reader is
encouraged to use keymap-set.
Thanks.
next prev parent reply other threads:[~2024-12-26 8:20 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-12-19 22:36 bug#74983: [PATCH] Use `keymap-set' instead of `define-key' in emacs lisp intro Hong Xu
2024-12-20 7:01 ` Eli Zaretskii
2024-12-20 9:35 ` Stefan Kangas
2024-12-20 21:42 ` bug#74999: [PATCH v2] Recommend " Hong Xu
2024-12-21 7:19 ` Eli Zaretskii
2024-12-21 8:03 ` bug#74999: [PATCH v3] " Hong Xu
2024-12-23 20:42 ` Hong Xu
2024-12-24 3:27 ` Eli Zaretskii
2024-12-26 8:20 ` Eli Zaretskii [this message]
2024-12-26 21:46 ` bug#74999: [PATCH v4] Use `keymap*-set' over `global-set-key'/`define-key' in elisp intro Hong Xu
2024-12-21 8:06 ` bug#74999: [PATCH v2] Recommend `keymap-set' instead of `define-key' in emacs lisp intro Hong Xu
2024-12-20 15:43 ` bug#74983: [PATCH] Use " Drew Adams via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-12-20 21:50 ` Hong Xu
2024-12-21 7:20 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=86ed1uzwhw.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=74999@debbugs.gnu.org \
--cc=hong@topbug.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).