bug#56261: [PATCH] maintaining.texi: typo

bug#56261: [PATCH] maintaining.texi: typo

[Jose A Ortega Ruiz]

[-- Attachment #1: Type: text/plain, Size: 482 bytes --]

Tags: patch


A trivial typo in the manual for xref.


In GNU Emacs 29.0.50 (build 10, x86_64-pc-linux-gnu, cairo version 1.16.0)
 of 2022-06-26 built on rivendell
Repository revision: 78c0c8673bba086842ef9ea57f44f446558e5ebf
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.12101003
System Description: Debian GNU/Linux bookworm/sid

Configured using:
 'configure --prefix=/usr/local/stow/emacs --with-x-toolkit=no
 --with-small-ja-dic'


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-maintaining.texi-typo.patch --]
[-- Type: text/patch, Size: 787 bytes --]

From e91426cffefcbfc269d647a810a23173c6673a1e Mon Sep 17 00:00:00 2001
From: Jose A Ortega Ruiz <jao@gnu.org>
Date: Mon, 27 Jun 2022 16:13:47 +0100
Subject: [PATCH] maintaining.texi: typo

---
 doc/emacs/maintaining.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi
index e5b3664a4c..81fd278da0 100644
--- a/doc/emacs/maintaining.texi
+++ b/doc/emacs/maintaining.texi
@@ -2222,7 +2222,7 @@ Looking Up Identifiers
 
 @kindex C-M-,
 @findex xref-go-forward
-  Go forward to a place from where you previously went back using @kbd{M-,}.
+  Go forward to a place from where you previously went back using @kbd{C-M-,}.
 This is useful if you find that you went back too far.
 
 @findex xref-etags-mode
-- 
2.36.1

bug#56261: [PATCH] maintaining.texi: typo

[Eli Zaretskii]

> From: Jose A Ortega Ruiz <jao@gnu.org>
> Date: Mon, 27 Jun 2022 16:15:45 +0100
> 
> >From e91426cffefcbfc269d647a810a23173c6673a1e Mon Sep 17 00:00:00 2001
> From: Jose A Ortega Ruiz <jao@gnu.org>
> Date: Mon, 27 Jun 2022 16:13:47 +0100
> Subject: [PATCH] maintaining.texi: typo
> 
> ---
>  doc/emacs/maintaining.texi | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi
> index e5b3664a4c..81fd278da0 100644
> --- a/doc/emacs/maintaining.texi
> +++ b/doc/emacs/maintaining.texi
> @@ -2222,7 +2222,7 @@ Looking Up Identifiers
>  
>  @kindex C-M-,
>  @findex xref-go-forward
> -  Go forward to a place from where you previously went back using @kbd{M-,}.
> +  Go forward to a place from where you previously went back using @kbd{C-M-,}.

That is not a typo.  After typing M-., you can type M-, to return to
where you typed M-. and then you can type C-M-, to go to the place
from which you returned.

bug#56261: [PATCH] maintaining.texi: typo

[Jose A Ortega Ruiz]

On Mon, Jun 27 2022, Eli Zaretskii wrote:

>>  @findex xref-go-forward
>> -  Go forward to a place from where you previously went back using @kbd{M-,}.
>> +  Go forward to a place from where you previously went back using @kbd{C-M-,}.
>
> That is not a typo.  After typing M-., you can type M-, to return to
> where you typed M-. and then you can type C-M-, to go to the place
> from which you returned.

i misread that "using" as if it had a "by" in front.  in the rendered
texinfo (at least for me), that paragraph reads as:

      Go forward to a place from where you previously went back using
   ‘M-,’.  This is useful if you find that you went back too far.

and there's no reference anywhere to xref-go-forward, so it's hard to
infer that that sentence is referring to that command.

bug#56261: [PATCH] maintaining.texi: typo

[Lars Ingebrigtsen]

Jose A Ortega Ruiz <jao@gnu.org> writes:

> i misread that "using" as if it had a "by" in front.  in the rendered
> texinfo (at least for me), that paragraph reads as:
>
>       Go forward to a place from where you previously went back using
>    ‘M-,’.  This is useful if you find that you went back too far.
>
> and there's no reference anywhere to xref-go-forward, so it's hard to
> infer that that sentence is referring to that command.

Yes, that seems to be phrased in a way that could easily be
misunderstood.  I've now rephrased it in Emacs 29.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#56261: [PATCH] maintaining.texi: typo

[Jose A Ortega Ruiz]

On Tue, Jun 28 2022, Lars Ingebrigtsen wrote:

> Jose A Ortega Ruiz <jao@gnu.org> writes:
>
>> i misread that "using" as if it had a "by" in front.  in the rendered
>> texinfo (at least for me), that paragraph reads as:
>>
>>       Go forward to a place from where you previously went back using
>>    ‘M-,’.  This is useful if you find that you went back too far.
>>
>> and there's no reference anywhere to xref-go-forward, so it's hard to
>> infer that that sentence is referring to that command.
>
> Yes, that seems to be phrased in a way that could easily be
> misunderstood.  I've now rephrased it in Emacs 29.

thanks.  if i'm reading the diff correctly:

   +  If you previously went back too far with @kbd{M-,}, @kbd{C-M-,}
   +(@code{xref-go-forward} can be used to go forward again.

could it be that there's a missing ) in the second line? other than
that, it's crystal clear now!

cheers,
jao
-- 
"When you come to a fork in the road, take it"
 -Yogi Berra, baseball coach.

bug#56261: [PATCH] maintaining.texi: typo

[Lars Ingebrigtsen]

Jose A Ortega Ruiz <jao@gnu.org> writes:

> thanks.  if i'm reading the diff correctly:
>
>    +  If you previously went back too far with @kbd{M-,}, @kbd{C-M-,}
>    +(@code{xref-go-forward} can be used to go forward again.
>
> could it be that there's a missing ) in the second line?

Yup; thanks.  Now fixed.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no