GNU bug report logs - #55647
Emacs manual - Change references to "global-set-key" to "keymap-global-set"

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 55647 in the body.
You can then email your comments to 55647 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: dhanvanthri <dhan1thri <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: Emacs manual - Change references to "global-set-key" to
 "keymap-global-set"
Date: Wed, 25 May 2022 18:16:23 -0500

Hey there,
    The documentation for global-set-key mentions that it's been 
deprecated in favour of keymap-global-set, however the manual still 
contains references to global-set-key.
    I was not able to find a way to make the changes and submit them, 
and I'm sure there are more references to it than just inside the 
rebinding keys documentation.
    If someone could show me how, I will make the edits myself and 
submit them, else I would really appreciate if someone could do so.

Regards,
-Dhanvanthri

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: dhanvanthri <dhan1thri <at> gmail.com>
Cc: 55647 <at> debbugs.gnu.org
Subject: Re: bug#55647: Emacs manual - Change references to "global-set-key" to
 "keymap-global-set"
Date: Thu, 26 May 2022 08:32:53 +0300

> Date: Wed, 25 May 2022 18:16:23 -0500
> From: dhanvanthri <dhan1thri <at> gmail.com>
> 
> Hey there,
>      The documentation for global-set-key mentions that it's been 
> deprecated in favour of keymap-global-set, however the manual still 
> contains references to global-set-key.

Thank you for your report.

I see only one reference to global-set-key, and that's to the command
global-set-key, in the ELisp reference manual.  Do you see more
references?

>      I was not able to find a way to make the changes and submit them, 
> and I'm sure there are more references to it than just inside the 
> rebinding keys documentation.
>      If someone could show me how, I will make the edits myself and 
> submit them, else I would really appreciate if someone could do so.

You should edit the corresponding *.texi files, and submit the
differences, preferably in the format of "git format-patch", or in the
format of "diff -u OLD NEW".

Thanks.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Dhanvanthri N <dhan1thri <at> gmail.com>
Cc: 55647 <at> debbugs.gnu.org
Subject: Re: bug#55647: Emacs manual - Change references to "global-set-key"
 to "keymap-global-set"
Date: Sun, 29 May 2022 08:45:42 +0300

[Please use Reply All to keep the bug tracker on the CC list.]

> From: Dhanvanthri N <dhan1thri <at> gmail.com>
> Date: Sat, 28 May 2022 18:10:05 -0500
> 
> I just switched back to stable, since native-comp is in 28; I notice 
> that in 28, the documentation doesn't mention keymap-global-set, is this 
> something that was introduced in 29?

Yes.

> I'm not sure how to find all the references to global-set-key in the 
> documentation;

Grep the *.texi files in the doc/lispref/ and doc/emacs/ directories
of the Emacs source tree for the references to the obsolete functions
and commands.

> however if it's only in the documentation for 
> global-set-key, should I still submit a patch?

No need for that one case, thanks.

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Dhanvanthri N <dhan1thri <at> gmail.com>, 55647 <at> debbugs.gnu.org
Subject: Re: bug#55647: Emacs manual - Change references to "global-set-key"
 to "keymap-global-set"
Date: Tue, 7 Jun 2022 17:35:09 -0500

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

>> I'm not sure how to find all the references to global-set-key in the
>> documentation;
>
> Grep the *.texi files in the doc/lispref/ and doc/emacs/ directories
> of the Emacs source tree for the references to the obsolete functions
> and commands.

I think there are quite a few of these.

However, I'm not sure that there is a strong need to change them for
Emacs 29 -- at least not in the user documentation.  Users might be
consulting Emacs 29 documentation, yet still want to use their Init file
on Emacs 28 or older.

How about waiting with updating all of this documentation on master
until after Emacs 29 has been released?

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: dhan1thri <at> gmail.com, 55647 <at> debbugs.gnu.org
Subject: Re: bug#55647: Emacs manual - Change references to "global-set-key"
 to "keymap-global-set"
Date: Wed, 08 Jun 2022 05:34:29 +0300

> From: Stefan Kangas <stefan <at> marxist.se>
> Date: Tue, 7 Jun 2022 17:35:09 -0500
> Cc: Dhanvanthri N <dhan1thri <at> gmail.com>, 55647 <at> debbugs.gnu.org
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> 
> >> I'm not sure how to find all the references to global-set-key in the
> >> documentation;
> >
> > Grep the *.texi files in the doc/lispref/ and doc/emacs/ directories
> > of the Emacs source tree for the references to the obsolete functions
> > and commands.
> 
> I think there are quite a few of these.
> 
> However, I'm not sure that there is a strong need to change them for
> Emacs 29 -- at least not in the user documentation.  Users might be
> consulting Emacs 29 documentation, yet still want to use their Init file
> on Emacs 28 or older.
> 
> How about waiting with updating all of this documentation on master
> until after Emacs 29 has been released?

The question is actually whether we indeed consider global-set-key and
friends obsolete.  If we do, we should at least document the modern
replacements and say that the obsolete ones are obsolete.  Leaving the
documentation as-is without reference to obsolescence is not a good
idea, IMO.

Message #30 received at 55647-done <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Dhanvanthri N <dhan1thri <at> gmail.com>, 55647-done <at> debbugs.gnu.org
Subject: Re: bug#55647: Emacs manual - Change references to "global-set-key"
 to "keymap-global-set"
Date: Tue, 11 Mar 2025 16:18:45 -0400

Version: 31.1

>>> I'm not sure how to find all the references to global-set-key in the
>>> documentation;

[...]

> How about waiting with updating all of this documentation on master
> until after Emacs 29 has been released?

Emacs 29.1 was released on 2023-07-30, so I made the change now.

I'm therefore closing this bug report.

Previous Next

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