This is the mail archive of the
gdb-patches@sourceware.cygnus.com
mailing list for the GDB project.
Re: Include GDB/MI docs in GDB manual
- To: Dmitry Sivachenko <dima at Chg dot RU>
- Subject: Re: Include GDB/MI docs in GDB manual
- From: Eli Zaretskii <eliz at delorie dot com>
- Date: Mon, 17 Apr 2000 07:22:44 -0400 (EDT)
- CC: gdb-patches at sourceware dot cygnus dot com
- References: <200004170956.NAA55866@netserv1.chg.ru>
- Reply-to: Eli Zaretskii <eliz at is dot elta dot co dot il>
> I think it is not good thing to include gdbmi.texinfo into
> GDB manual.
I asked about this a couple of weeks ago, and the general concensus
was that it was a good idea.
> It contains very technical issues, which regular users
> would not be happy to see in the Manual.
> GDB manual should contain things which describe using of the debugger
> from the users's point of view.
The GDB/MI docs are no more technical than annotate.texi. They both
describe similar interfaces for similar purposes. So if one of them
shouldn't be in gdb.texinfo, so should the other.
In a nutshell, GDB/MI is no more than a command language, albeit
different from the CLI and somewhat awkward for human consumption.
Please also note that a ``GDB user'' is not a ``normal'' user in the
usual sense. We are dealing with a developer who debugs programs.
Such users shouldn't be afraid of technical details.
> Probably it should be better included into gdbint.texinfo.
I actually thought about this possibility, but rejected it:
gdbint.texinfo is about GDB *internals*, whereas GDB/MI is one of GDB
*features* meant to be used by external programs.
> Or left as a separate book.
This is what I asked a few weeks ago, and IIRC everybody wanted it
inside the manual.