This is the mail archive of the gdb-patches@sourceware.cygnus.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]

Re: Move remote protocol doc to separate chapter?



> 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.

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