This is the mail archive of the gdb-patches@sources.redhat.com mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [RFA]: File-I/O patch, Documentation


> Date: Thu, 21 Nov 2002 10:22:01 +0100
> From: Corinna Vinschen <vinschen@redhat.com>
> 
> Subsitute
> 
> > +The integral datatypes are conforming to the definition in B.1 so this
> > +structure is of size 64 bytes.
> 
> by
> 
>   The integral datatypes are conforming to the definitions given in the
>   approriate section (@xref{Integral datatypes}, for details) so this
>   structure is of size 64 bytes.

That's okay, but please don't use "@xref" except at the beginning of a
sentence, because it produces capitalized "Note:" and "See" in the
output.  In this case, I suggest instead to say

  approriate section (see @ref{Integral datatypes}, for details) so this


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]