bug#55647: Emacs manual - Change references to "global-set-key" to "keymap-global-set"

bug#55647: Emacs manual - Change references to "global-set-key" to "keymap-global-set"

[dhanvanthri]

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

bug#55647: Emacs manual - Change references to "global-set-key" to "keymap-global-set"

[Eli Zaretskii]

> Date: Wed, 25 May 2022 18:16:23 -0500
> From: dhanvanthri <dhan1thri@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.

bug#55647: Emacs manual - Change references to "global-set-key" to "keymap-global-set"

[Eli Zaretskii]

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

> From: Dhanvanthri N <dhan1thri@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.

bug#55647: Emacs manual - Change references to "global-set-key" to "keymap-global-set"

[Stefan Kangas]

Eli Zaretskii <eliz@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?

bug#55647: Emacs manual - Change references to "global-set-key" to "keymap-global-set"

[Eli Zaretskii]

> From: Stefan Kangas <stefan@marxist.se>
> Date: Tue, 7 Jun 2022 17:35:09 -0500
> Cc: Dhanvanthri N <dhan1thri@gmail.com>, 55647@debbugs.gnu.org
> 
> Eli Zaretskii <eliz@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.