make info warnings

make info warnings

[Elena Zannoni]

Am I the only one getting these warnings when building the docs?

makeinfo -I /home/ezannoni/sources/src/gdb/doc/../../readline/doc -I /home/ezannoni/sources/src/gdb/doc/../mi -I /home/ezannoni/sources/src/gdb/doc \
	-o gdb.info /home/ezannoni/sources/src/gdb/doc/gdb.texinfo
/home/ezannoni/sources/src/gdb/doc/gdb.texinfo:11908: warning: unlikely character [ in @var.
/home/ezannoni/sources/src/gdb/doc/gdb.texinfo:11908: warning: unlikely character ] in @var.
/home/ezannoni/sources/src/gdb/doc/gdb.texinfo:11919: warning: unlikely character [ in @var.
/home/ezannoni/sources/src/gdb/doc/gdb.texinfo:11919: warning: unlikely character ] in @var.
/home/ezannoni/sources/src/gdb/doc/gdb.texinfo:11926: warning: unlikely character [ in @var.
/home/ezannoni/sources/src/gdb/doc/gdb.texinfo:11926: warning: unlikely character [ in @var.
/home/ezannoni/sources/src/gdb/doc/gdb.texinfo:11926: warning: unlikely character ] in @var.
/home/ezannoni/sources/src/gdb/doc/gdb.texinfo:11926: warning: unlikely character ] in @var.

these are the lines that generate the warnings.

@item htrace record @var{[data]*}
@item htrace rewind @var{[filename]}
@item htrace print @var{[start [len]]}

It it easy to eliminate the warnings by using for instance @emph{} instead of
@var{}, but the look of the text changes slightly.

Eli, is there a correct way to fix this?

thanks
Elena

Re: make info warnings

[Andreas Schwab]

Elena Zannoni <ezannoni@redhat.com> writes:

|> these are the lines that generate the warnings.
|> 
|> @item htrace record @var{[data]*}
|> @item htrace rewind @var{[filename]}
|> @item htrace print @var{[start [len]]}

IMHO this should be written like this:

@item htrace record [@var{data}]*
@item htrace rewind [@var{filename}]
@item htrace print [@var{start} [@var{len}]]

Andreas.

-- 
Andreas Schwab, SuSE Labs, schwab@suse.de
SuSE Linux AG, Deutschherrnstr. 15-19, D-90429 Nürnberg
Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

Re: make info warnings

[Eli Zaretskii]

> From: Andreas Schwab <schwab@suse.de>
> Date: Wed, 15 Jan 2003 16:58:58 +0100
> 
> Elena Zannoni <ezannoni@redhat.com> writes:
> 
> |> these are the lines that generate the warnings.
> |> 
> |> @item htrace record @var{[data]*}
> |> @item htrace rewind @var{[filename]}
> |> @item htrace print @var{[start [len]]}
> 
> IMHO this should be written like this:
> 
> @item htrace record [@var{data}]*
> @item htrace rewind [@var{filename}]
> @item htrace print [@var{start} [@var{len}]]

Yes, that's the right fix.  It makes the printed version look better,
too.

Re: make info warnings

[Elena Zannoni]

Andreas Schwab writes:
 > Elena Zannoni <ezannoni@redhat.com> writes:
 > 
 > |> these are the lines that generate the warnings.
 > |> 
 > |> @item htrace record @var{[data]*}
 > |> @item htrace rewind @var{[filename]}
 > |> @item htrace print @var{[start [len]]}
 > 
 > IMHO this should be written like this:
 > 
 > @item htrace record [@var{data}]*
 > @item htrace rewind [@var{filename}]
 > @item htrace print [@var{start} [@var{len}]]

ah! yes, that would work.

Elena


 > 
 > Andreas.
 > 
 > -- 
 > Andreas Schwab, SuSE Labs, schwab@suse.de
 > SuSE Linux AG, Deutschherrnstr. 15-19, D-90429 Nürnberg
 > Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
 > "And now for something completely different."

Re: make info warnings

[Elena Zannoni]

Eli Zaretskii writes:
 > > From: Andreas Schwab <schwab@suse.de>
 > > Date: Wed, 15 Jan 2003 16:58:58 +0100
 > > 
 > > Elena Zannoni <ezannoni@redhat.com> writes:
 > > 
 > > |> these are the lines that generate the warnings.
 > > |> 
 > > |> @item htrace record @var{[data]*}
 > > |> @item htrace rewind @var{[filename]}
 > > |> @item htrace print @var{[start [len]]}
 > > 
 > > IMHO this should be written like this:
 > > 
 > > @item htrace record [@var{data}]*
 > > @item htrace rewind [@var{filename}]
 > > @item htrace print [@var{start} [@var{len}]]
 > 
 > Yes, that's the right fix.  It makes the printed version look better,
 > too.

Ok, here is a patch. I checked it in.

Elena


2003-01-15  Elena Zannoni  <ezannoni@redhat.com>

	(OpenRISC 1000): Fix formatting of command names.

Index: gdb.texinfo
===================================================================
RCS file: /cvs/uberbaum/gdb/doc/gdb.texinfo,v
retrieving revision 1.138
diff -u -p -r1.138 gdb.texinfo
--- gdb.texinfo	15 Jan 2003 14:31:59 -0000	1.138
+++ gdb.texinfo	15 Jan 2003 17:55:36 -0000
@@ -11904,7 +11904,7 @@ Set acquisition qualifier for HW trace.
 Set HW trace stopping criteria.
 
 @kindex htrace record
-@item htrace record @var{[data]*}
+@item htrace record [@var{data}]*
 Selects the data to be recorded, when qualifier is met and HW trace was
 triggered.
 
@@ -11915,14 +11915,14 @@ triggered.
 Enables/disables the HW trace.
 
 @kindex htrace rewind
-@item htrace rewind @var{[filename]}
+@item htrace rewind [@var{filename}]
 Clears currently recorded trace data.
 
 If filename is specified, new trace file is made and any newly collected data
 will be written there.
 
 @kindex htrace print
-@item htrace print @var{[start [len]]}
+@item htrace print [@var{start} [@var{len}]]
 Prints trace buffer, using current record configuration.
 
 @kindex htrace mode continuous

Re: make info warnings

[Michael Elizabeth Chastain]

Elena Z writes:

> Am I the only one getting these warnings when building the docs?

I get the same warnings (during 'make install', not 'make'),
on the same lines.  I'm running Red Hat Linux 8.0, and I'm
using the vendor-supplied version of texinfo.  'makeinfo --version'
says '4.2'.

Michael C