[PATCH RFA/RFC] Address class support
Kevin Buettner
kevinb@redhat.com
Thu Oct 17 11:15:00 GMT 2002
On Oct 17, 8:39am, Eli Zaretskii wrote:
> Approved, with the following comments/suggestions:
>
> > +@deftypefn {Target Macro} int ADDRESS_CLASS_TYPE_FLAGS (int @var{byte_size}, int @var{dwarf2_addr_class})
>
> Do you really need to use @var inside deftypefn (I don't have the Texinfo
> manual handy, sorry)? I thought the @def... directives supply the @var
> automatically.
According to the texinfo manual, an explicit @var is needed For deftypefn:
The argument names that you write in @deftypefn are not subject to
an implicit @var--since the actual names of the arguments in
@deftypefn are typically scattered among data type names and
keywords, Texinfo cannot find them without help. Instead, you
must write @var explicitly around the argument names. In the
example above, the argument names are foo and bar.
(I didn't know this ahead of time though; I was just following the
example set by the rest of the manual.)
> > +Consider a hypothetical architecture in which addresses are normally
> > +32-bits wide, but 16-bit addresses are also supported. Furthermore,
> > +suppose that the DWARF 2 information for this architecture simply
>
> I suggest to use either DWARF2 or @w{DWARF 2}, to prevent TeX and makeinfo
> from splitting this between DWARF and 2.
I'll use @w{DWARF 2} for consistency with the rest of the manual. (There
are some other places that need to be fixed though.)
> > +@smallexample
> > +somearch_address_class_type_flags (int byte_size, int dwarf2_addr_class)
>
> This line is too long (even for @smallexample), so please break it in
> two:
>
> +somearch_address_class_type_flags (int byte_size,
> + int dwarf2_addr_class)
>
> (There are more too long lines in your examples. In general, any line
> inside @smallexample that is longer than 64 characters should be broken
> into several lines, or else it will cause overfull hbox'es when you TeX
> the manual.)
Okay, fixed.
Thanks for your help.
Kevin
More information about the Gdb-patches
mailing list