unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Hong Xu <hong@topbug.net>
Cc: 74999@debbugs.gnu.org
Subject: bug#74999: [PATCH v4] Use `keymap*-set' over `global-set-key'/`define-key' in elisp intro
Date: Sat, 28 Dec 2024 14:17:28 +0200	[thread overview]
Message-ID: <86seq8roh3.fsf@gnu.org> (raw)
In-Reply-To: <20241226214814.52057-1-hong@topbug.net> (message from Hong Xu on Thu, 26 Dec 2024 13:46:39 -0800)

> From: Hong Xu <hong@topbug.net>
> Date: Thu, 26 Dec 2024 13:46:39 -0800
> 
> * 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.
> ---
>  doc/lispintro/emacs-lisp-intro.texi | 119 +++++++++++++++++++---------
>  1 file changed, 81 insertions(+), 38 deletions(-)

Thanks, I have a few minor comments:

>  @cindex Setting a key globally
> -@cindex Global set key
> +@cindex Keymap global set
>  @cindex Key setting globally
> -@findex global-set-key

Please add index entries for the new APIs, but do not remove the index
entries for old ones.  Readers could still need to look up the old
interfaces via index search.

> -@findex global-unset-key
> +@findex keymap-global-unset

Same here.

> +@subsection Legacy Global Key Binding Commands
> +
> +@findex global-set-key
> +@cindex Global set key
> +Historically, keys are bound globally using a lower-level function,
> +@code{global-set-key}, which is now considered legacy.  While you are
> +encouraged to use @code{keymap-global-set}, you likely would encounter
> +@code{global-set-key} in various places.  The first example can be
> +rewritten using @code{global-set-key} as:
> +
> +@smallexample
> +@group
> +(global-set-key "\C-cw" 'compare-windows)
> +@end group
> +@end smallexample

The text says "first example", but which example is that?  There are
no examples in this subsection.

> +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:

Same here: "the above key unbinding example" refers to an example in a
different subsection.

Thanks.





  parent reply	other threads:[~2024-12-28 12:17 UTC|newest]

Thread overview: 20+ 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
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-26 22:05               ` Hong Xu
2024-12-27  7:44                 ` Eli Zaretskii
2024-12-28 12:17               ` Eli Zaretskii [this message]
2024-12-28 19:56                 ` Hong Xu
2024-12-26 21:58             ` bug#74999: [PATCH v3] Recommend `keymap-set' instead of `define-key' in emacs lisp intro Hong Xu
2024-12-27  7:37               ` Eli Zaretskii
2024-12-21  8:06         ` bug#74999: [PATCH v2] " 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=86seq8roh3.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).