From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 9882 invoked by alias); 6 Nov 2004 10:12:50 -0000 Mailing-List: contact gdb-patches-help@sources.redhat.com; run by ezmlm Precedence: bulk List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sources.redhat.com Received: (qmail 9820 invoked from network); 6 Nov 2004 10:12:48 -0000 Received: from unknown (HELO balder.inter.net.il) (192.114.186.15) by sourceware.org with SMTP; 6 Nov 2004 10:12:48 -0000 Received: from zaretski (pns03-208-208.inter.net.il [80.230.208.208]) by balder.inter.net.il (Mirapoint Messaging Server MOS 3.3.7-GR) with ESMTP id DVV17628 (AUTH halo1); Sat, 6 Nov 2004 12:12:37 +0200 (IST) Date: Sat, 06 Nov 2004 10:12:00 -0000 From: "Eli Zaretskii" To: Bob Rossi Message-ID: <01c4c3e8$Blat.v2.2.2$853fdac0@zahav.net.il> Content-Transfer-Encoding: 7BIT Content-Type: text/plain; charset=ISO-8859-1 CC: gdb-patches@sources.redhat.com In-reply-to: <20041105221222.GC8318@white> (message from Bob Rossi on Fri, 5 Nov 2004 17:12:22 -0500) Subject: Re: MI handshaking Reply-to: Eli Zaretskii References: <20041104195701.GA7296@white> <01c4c2b4$Blat.v2.2.2$a21985e0@zahav.net.il> <20041105163933.GB8318@white> <01c4c35f$Blat.v2.2.2$3c749800@zahav.net.il> <20041105221222.GC8318@white> X-SW-Source: 2004-11/txt/msg00109.txt.bz2 > Date: Fri, 5 Nov 2004 17:12:22 -0500 > From: Bob Rossi > Cc: gdb-patches@sources.redhat.com > > I really am not good at editing info files but am trying to do my > best to help out. You are doing a good job, although I have a few more minor comments, see below. The @cindex lines are collected by the program that generates the Info files and put into the "Index" node. Thereafter, you can use the `i' command in the Info readers to quickly find stuff in the manual; that command works by searching the string you type in the index. This is the most efficient means of using the manual as a reference, when you know something is in the manual and need a fast way of finding it. If you want to learn more about Texinfo, I suggest to read the manual that comes with the Texinfo package. > +@item > +For more information on handshaking see @ref{GDB/MI Handshaking Interface} > +@end itemize Don't make this an @item (just a simple sentence that goes after @end itemize), and make sure there's a period or comma after the closing brace of @ref{...}. > +However, if @value{GDBN} is started with the -i=mi flag, then this tells The "-i=mi" part should be in @samp{}. > +untested protocols, they could simply try to invoke @value{GDBN} with > +-i=mi@var{N}, where @var{N} is version they wish to communicate with. Same here. And please don't use caps inside @var{}, as they look ugly in print. > +@cindex @dfn{stable MI protocol} No need for @dfn in the index entries. > +a CVS snapshot will have depricated @sc{mi} protocols, stable @sc{mi} ^^^^^^^^^^ "deprecated" > +protocols and development @sc{mi} protocols. The depricated @sc{mi} protocols ^^^^^^^^^^ Same here. > +eventually get removed. The @dfn{stable MI protocols} are considered stable @dfn should be used only once, the first time you introduce the term. After that, simply use the term without any markup or quoting.