This is the mail archive of the
gdb-patches@sourceware.cygnus.com
mailing list for the GDB project.
Re: Move remote protocol doc to separate chapter?
- To: shebs at apple dot com
- Subject: Re: Move remote protocol doc to separate chapter?
- From: Eli Zaretskii <eliz at delorie dot com>
- Date: Sun, 2 Apr 2000 04:19:03 -0400 (EDT)
- CC: ac131313 at cygnus dot com, gdb-patches at sourceware dot cygnus dot com
- References: <38E17FD0.FF46C21A@cygnus.com> <38E2548D.DFE10D16@apple.com>
- Reply-to: Eli Zaretskii <eliz at is dot elta dot co dot il>
> On the other hand, the manual should be organized for easy lookup of
> of its key information, and the remote protocol is one of those key
> areas. It's also likely to get larger and more detailed over time,
> and when the agentexpr.texi file gets merged in as it should (it's
> a part of the protocol, eh?), it will be even larger. So when I
> think about it that way, a chapter dedicated to the standard protocol
> makes a lot of sense.
You could use indexing to make the remote protocol info easily
accessible, even without having a special chapter for it. For
example, having an index entry like this:
@cindex remote protocol, FOO
where some feature FOO is described, will allow to quickly look up
that place using the `i' (index-search) command in Info.
In addition, we could have a chapter dedicated to remote protocol that
has only a list of references to other chapters which describe the
relevant features.