This is the mail archive of the
gdb-patches@sources.redhat.com
mailing list for the GDB project.
Re: [rfa] libgdb updates to doco
- To: ac131313 at cygnus dot com
- Subject: Re: [rfa] libgdb updates to doco
- From: "Eli Zaretskii" <eliz at is dot elta dot co dot il>
- Date: Fri, 27 Jul 2001 12:37:14 +0300
- CC: gdb-patches at sources dot redhat dot com
- References: <Pine.SUN.3.91.1010726095158.28739G-100000@is> <3B606479.2070205@cygnus.com>
- Reply-to: Eli Zaretskii <eliz at is dot elta dot co dot il>
> Date: Thu, 26 Jul 2001 14:42:01 -0400
> From: Andrew Cagney <ac131313@cygnus.com>
>
> > Texinfo cross-references (and thus index entries) refer to the
> > enclosing node in the Info version, so having smaller nodes makes sure
> > you will land close to the stuff you are looking for. (There's the
> > new @anchor directive which is free from this limitation, but older
> > Info readers don't support it, so we should not yet use it too much;
> > and index entries don't produce @anchor's anyway.)
>
> For my part, I was looking for an existing example but couldn't find one
Just put a @node before each @section and @subsection. While at that,
consider converting @heading and @subheading into @section and
@subsection, and then apply the first rule again ;-).
> I've checked in the libgdb stuff. Hmm, whats next?
How about documenting multi-arch so that I could understand how to
multi-arch a target without reading the code? ;-)