[rfa:doco] Fix that stabs warning ...

Andrew Cagney
2003-03-03T19:18:32Z

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

Hello,

The attatched patch fixes the makeinfo warning printed when generating
the stabs documentation:

makeinfo -o stabs.info
/home/scratch/PENDING/2003-03-03-doco-stabs-vars/src/gdb/doc/stabs.texinfo
/home/scratch/PENDING/2003-03-03-doco-stabs-vars/src/gdb/doc/stabs.texinfo:2051:
warning: unlikely character , in @var.
/home/scratch/PENDING/2003-03-03-doco-stabs-vars/src/gdb/doc/stabs.texinfo:2051:
warning: unlikely character , in @var.
/home/scratch/PENDING/2003-03-03-doco-stabs-vars/src/gdb/doc/stabs.texinfo:2150:
warning: unlikely character , in @var.
/home/scratch/PENDING/2003-03-03-doco-stabs-vars/src/gdb/doc/stabs.texinfo:2150:
warning: unlikely character , in @var.

Ok?

Andrew

[-- Attachment #2: diffs --]
[-- Type: text/plain, Size: 1553 bytes --]

2003-03-03 Andrew Cagney <cagney@redhat.com>

* stabs.texinfo (Structures): Use @samp and separate @var's
instead of a single @var containing a list.
(Unions): Ditto.

Index: stabs.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/stabs.texinfo,v
retrieving revision 1.9
diff -u -r1.9 stabs.texinfo
--- stabs.texinfo 30 Jan 2003 15:44:43 -0000 1.9
+++ stabs.texinfo 3 Mar 2003 19:15:32 -0000
@@ -2047,8 +2047,9 @@

Following the @samp{s} type descriptor is the number of bytes the
structure occupies, followed by a description of each structure element.
-The structure element descriptions are of the form @var{name:type, bit
-offset from the start of the struct, number of bits in the element}.
+The structure element descriptions are of the form
+@samp{@var{name}:@var{type}, @var{bit offset from the start of the
+struct}, @var{number of bits in the element}}.

@c FIXME: phony line break. Can probably be fixed by using an example
@c with fewer fields.
@@ -2146,8 +2147,8 @@
descriptor @samp{u}, following the @samp{23=} of the type definition,
narrows it down to a union type definition. Following the @samp{u} is
the number of bytes in the union. After that is a list of union element
-descriptions. Their format is @var{name:type, bit offset into the
-union, number of bytes for the element;}.
+descriptions. Their format is @samp{@var{name}:@var{type}, @var{bit
+offset into the union}, @var{number of bytes for the element};}.

The stab for the union variable is: