[committed] Fix gdb.texinfo for old makeinfo (again)

[committed] Fix gdb.texinfo for old makeinfo (again)

[Szabolcs Nagy]

With old makeinfo (version 4.13) the changes introduced in

commit ba643918cf869fa0d064d733f69b453b6fe642ea
Author:     Sergio Durigan Junior <sergiodj@redhat.com>

    Install and generate docs for gdb-add-index

fail to build with

gdb/doc/gdb.texinfo:2498: warning: `.' or `,' must follow @xref, not `@'.
gdb/doc/gdb.texinfo:2517: warning: `.' or `,' must follow @xref, not `@'.
gdb/doc/gdb.texinfo:43443: Node `gdb-add-index man' requires a sectioning command (e.g., @unnumberedsubsec).
gdb/doc/gdb.texinfo:43443: `gdb-add-index man' has no Up field (perhaps incorrect sectioning?).
gdb/doc/gdb.texinfo:43350: Next field of node `gdbinit man' not pointed to (perhaps incorrect sectioning?).
gdb/doc/gdb.texinfo:43443: This node (gdb-add-index man) has the bad Prev.

This patch fixes the warnings too.
Committed as obvious.

gdb/doc/ChangeLog:
2018-01-15  Szabolcs Nagy  <szabolcs.nagy@arm.com>

	* gdb.texinfo (set cwd): Add period.
	(gdb-add-index): Move anchor.

Re: [committed] Fix gdb.texinfo for old makeinfo (again)

[Szabolcs Nagy]

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

On 15/01/18 11:48, Szabolcs Nagy wrote:
> gdb/doc/ChangeLog:
> 2018-01-15  Szabolcs Nagy  <szabolcs.nagy@arm.com>
> 
> 	* gdb.texinfo (set cwd): Add period.
> 	(gdb-add-index): Move anchor.
> 

now with patch attached.


[-- Attachment #2: info.diff --]
[-- Type: text/x-patch, Size: 953 bytes --]

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index b6e7a4975e..75789a27c2 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -2495,7 +2495,7 @@ fallback.
 
 You can also change @value{GDBN}'s current working directory by using
 the @code{cd} command.
-@xref{cd command}
+@xref{cd command}.
 
 @kindex show cwd
 @cindex show inferior's working directory
@@ -2514,7 +2514,7 @@ given, @var{directory} uses @file{'~'}.
 The @value{GDBN} working directory serves as a default for the
 commands that specify files for @value{GDBN} to operate on.
 @xref{Files, ,Commands to Specify Files}.
-@xref{set cwd command}
+@xref{set cwd command}.
 
 @kindex pwd
 @item pwd
@@ -43441,9 +43441,8 @@ Richard M. Stallman and Roland H. Pesch, July 1991.
 @c man end
 
 @node gdb-add-index man
-@pindex gdb-add-index
-@anchor{gdb-add-index}
 @heading gdb-add-index
+@anchor{gdb-add-index}
 
 @c man title gdb-add-index Add index files to speed up GDB
 

Re: [committed] Fix gdb.texinfo for old makeinfo (again)

[Eli Zaretskii]

> Date: Mon, 15 Jan 2018 11:48:20 +0000
> From: Szabolcs Nagy <szabolcs.nagy@arm.com>
> CC: nd@arm.com, Sergio Durigan Junior <sergiodj@redhat.com>, 
>  Simon Marchi <simon.marchi@polymtl.ca>,
>  Tom Tromey <tom@tromey.com>, Eli Zaretskii <eliz@gnu.org>
> 
> With old makeinfo (version 4.13) the changes introduced in
> 
> commit ba643918cf869fa0d064d733f69b453b6fe642ea
> Author:     Sergio Durigan Junior <sergiodj@redhat.com>
> 
>     Install and generate docs for gdb-add-index
> 
> fail to build with
> 
> gdb/doc/gdb.texinfo:2498: warning: `.' or `,' must follow @xref, not `@'.
> gdb/doc/gdb.texinfo:2517: warning: `.' or `,' must follow @xref, not `@'.
> gdb/doc/gdb.texinfo:43443: Node `gdb-add-index man' requires a sectioning command (e.g., @unnumberedsubsec).
> gdb/doc/gdb.texinfo:43443: `gdb-add-index man' has no Up field (perhaps incorrect sectioning?).
> gdb/doc/gdb.texinfo:43350: Next field of node `gdbinit man' not pointed to (perhaps incorrect sectioning?).
> gdb/doc/gdb.texinfo:43443: This node (gdb-add-index man) has the bad Prev.
> 
> This patch fixes the warnings too.
> Committed as obvious.

Thanks.

Re: [committed] Fix gdb.texinfo for old makeinfo (again)

[Eli Zaretskii]

> Date: Mon, 15 Jan 2018 11:51:52 +0000
> From: Szabolcs Nagy <szabolcs.nagy@arm.com>
> CC: nd@arm.com, Sergio Durigan Junior <sergiodj@redhat.com>,  Simon Marchi <simon.marchi@polymtl.ca>, Tom Tromey <tom@tromey.com>, Eli Zaretskii <eliz@gnu.org>
> now with patch attached.

Hmm... why did you need this one:

> -@pindex gdb-add-index

That's an index entry for gdb-add-index, it should stay, I think.

Re: [committed] Fix gdb.texinfo for old makeinfo (again)

[Szabolcs Nagy]

On 15/01/18 12:11, Eli Zaretskii wrote:
>> Date: Mon, 15 Jan 2018 11:51:52 +0000
>> From: Szabolcs Nagy <szabolcs.nagy@arm.com>
>> CC: nd@arm.com, Sergio Durigan Junior <sergiodj@redhat.com>,  Simon Marchi <simon.marchi@polymtl.ca>, Tom Tromey <tom@tromey.com>, Eli Zaretskii <eliz@gnu.org>
>> now with patch attached.
> 
> Hmm... why did you need this one:
> 
>> -@pindex gdb-add-index
> 
> That's an index entry for gdb-add-index, it should stay, I think.
> 

i still get the error if i keep @pindex there,
if i move it together with @anchor below @heading
that works, shall i make that change?

(i just wanted to unbreak the build for our
automated toolchain tests, but there might be
better fix)

Re: [committed] Fix gdb.texinfo for old makeinfo (again)

[Eli Zaretskii]

> Date: Mon, 15 Jan 2018 12:25:26 +0000
> From: Szabolcs Nagy <szabolcs.nagy@arm.com>
> CC: nd@arm.com, gdb-patches@sourceware.org, sergiodj@redhat.com, 
>  simon.marchi@polymtl.ca, tom@tromey.com
> >> -@pindex gdb-add-index
> > 
> > That's an index entry for gdb-add-index, it should stay, I think.
> > 
> 
> i still get the error if i keep @pindex there,
> if i move it together with @anchor below @heading
> that works, shall i make that change?

Yes, @pindex should be below @heading.

Thanks.

> (i just wanted to unbreak the build for our
> automated toolchain tests

Understood.

Re: [committed] Fix gdb.texinfo for old makeinfo (again)

[Sergio Durigan Junior]

On Monday, January 15 2018, Szabolcs Nagy wrote:

> With old makeinfo (version 4.13) the changes introduced in
>
> commit ba643918cf869fa0d064d733f69b453b6fe642ea
> Author:     Sergio Durigan Junior <sergiodj@redhat.com>
>
>     Install and generate docs for gdb-add-index
>
> fail to build with
>
> gdb/doc/gdb.texinfo:2498: warning: `.' or `,' must follow @xref, not `@'.
> gdb/doc/gdb.texinfo:2517: warning: `.' or `,' must follow @xref, not `@'.
> gdb/doc/gdb.texinfo:43443: Node `gdb-add-index man' requires a sectioning command (e.g., @unnumberedsubsec).
> gdb/doc/gdb.texinfo:43443: `gdb-add-index man' has no Up field (perhaps incorrect sectioning?).
> gdb/doc/gdb.texinfo:43350: Next field of node `gdbinit man' not pointed to (perhaps incorrect sectioning?).
> gdb/doc/gdb.texinfo:43443: This node (gdb-add-index man) has the bad Prev.
>
> This patch fixes the warnings too.
> Committed as obvious.
>
> gdb/doc/ChangeLog:
> 2018-01-15  Szabolcs Nagy  <szabolcs.nagy@arm.com>
>
> 	* gdb.texinfo (set cwd): Add period.
> 	(gdb-add-index): Move anchor.

Thanks for catching this.  I confess I don't have makeinfo 4.13
installed and didn't think I needed to test generating the docs with it.

-- 
Sergio
GPG key ID: 237A 54B1 0287 28BF 00EF  31F4 D0EB 7628 65FC 5E36
Please send encrypted e-mail if possible
http://sergiodj.net/

Re: [committed] Fix gdb.texinfo for old makeinfo (again)

[Eli Zaretskii]

> From: Sergio Durigan Junior <sergiodj@redhat.com>
> Cc: gdb-patches@sourceware.org,  nd@arm.com,  Simon Marchi <simon.marchi@polymtl.ca>,  Tom Tromey <tom@tromey.com>,  Eli Zaretskii <eliz@gnu.org>
> Date: Mon, 15 Jan 2018 08:14:39 -0500
> 
> > 	* gdb.texinfo (set cwd): Add period.
> > 	(gdb-add-index): Move anchor.
> 
> Thanks for catching this.  I confess I don't have makeinfo 4.13
> installed and didn't think I needed to test generating the docs with it.

Cross-references must have period or comma following them, it's just
that latest versions of makeinfo are lenient in enforcing that.

[committed] Fix gdb.texinfo more

[Szabolcs Nagy]

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

On 15/01/18 12:58, Eli Zaretskii wrote:
> Yes, @pindex should be below @heading.

Add incorrectly removed @pindex back.

gdb/doc/ChangeLog:
2018-01-15  Szabolcs Nagy  <szabolcs.nagy@arm.com>

	* gdb.texinfo (gdb-add-index man): Add pindex.



[-- Attachment #2: a.diff --]
[-- Type: text/x-patch, Size: 379 bytes --]

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 75789a27c2..9ddfba504c 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -43442,6 +43442,7 @@ Richard M. Stallman and Roland H. Pesch, July 1991.
 
 @node gdb-add-index man
 @heading gdb-add-index
+@pindex gdb-add-index
 @anchor{gdb-add-index}
 
 @c man title gdb-add-index Add index files to speed up GDB

Re: [committed] Fix gdb.texinfo for old makeinfo (again)

[Sergio Durigan Junior]

On Monday, January 15 2018, Eli Zaretskii wrote:

>> From: Sergio Durigan Junior <sergiodj@redhat.com>
>> Cc: gdb-patches@sourceware.org,  nd@arm.com,  Simon Marchi <simon.marchi@polymtl.ca>,  Tom Tromey <tom@tromey.com>,  Eli Zaretskii <eliz@gnu.org>
>> Date: Mon, 15 Jan 2018 08:14:39 -0500
>> 
>> > 	* gdb.texinfo (set cwd): Add period.
>> > 	(gdb-add-index): Move anchor.
>> 
>> Thanks for catching this.  I confess I don't have makeinfo 4.13
>> installed and didn't think I needed to test generating the docs with it.
>
> Cross-references must have period or comma following them, it's just
> that latest versions of makeinfo are lenient in enforcing that.

Ah, fair enough.  Thanks for the explanation, Eli!

-- 
Sergio
GPG key ID: 237A 54B1 0287 28BF 00EF  31F4 D0EB 7628 65FC 5E36
Please send encrypted e-mail if possible
http://sergiodj.net/