From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 2768 invoked by alias); 5 Nov 2004 17:50:00 -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 2759 invoked from network); 5 Nov 2004 17:49:57 -0000 Received: from unknown (HELO balder.inter.net.il) (192.114.186.15) by sourceware.org with SMTP; 5 Nov 2004 17:49:57 -0000 Received: from zaretski ([80.230.154.71]) by balder.inter.net.il (Mirapoint Messaging Server MOS 3.3.7-GR) with ESMTP id DVU91831 (AUTH halo1); Fri, 5 Nov 2004 19:49:48 +0200 (IST) Date: Fri, 05 Nov 2004 17:50:00 -0000 From: "Eli Zaretskii" To: Bob Rossi Message-ID: <01c4c35f$Blat.v2.2.2$3c749800@zahav.net.il> Content-Transfer-Encoding: 7BIT Content-Type: text/plain; charset=ISO-8859-1 CC: gdb-patches@sources.redhat.com In-reply-to: <20041105163933.GB8318@white> (message from Bob Rossi on Fri, 5 Nov 2004 11:39:33 -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> X-SW-Source: 2004-11/txt/msg00082.txt.bz2 > Date: Fri, 5 Nov 2004 11:39:33 -0500 > From: Bob Rossi > Cc: gdb-patches@sources.redhat.com > > +@node GDB/MI Handshaking Syntax > +@subsection @sc{gdb/mi} Handshaking Syntax > + > +@cindex handshaking syntax for @sc{gdb/mi} > +@cindex @sc{gdb/mi}, handshaking syntax > +@table @code > +@item @var{handshake_output} @expansion{} > +@code{"handshake=@{stable_protocols=@{" @var{mi-protocol-list} > +"@}" @var{nl}} I think there's a need here for a cross-reference to the section that explains the reason and principles of the handshaking (the other section you wrote), otherwise this table looks awkwardly unexplained. > +It is possible to start the @sc{gdb/mi} interpreter using -i=mi1, -i=mi2, or > +simply with -i=mi. The command-line options should be in @samp{} or in @option{}, like this: It is possible to start the @sc{gdb/mi} interpreter using @samp{-i=mi1} Actually, instead of using literal mi1 and mi2, which could confuse the reader into thinking that only MI1 and MI2 are supported (think about someone reading this 10 years from now), I'd say It is possible to start the @sc{gdb/mi} interpreter using @samp{-i=mi@var{n}}, where @var{n} is the MI protocol version (@pxref{Interpreters}). When invoked with a specific version of the MI interpreter, @value{GDBN} will bypass the handshaking mode and go directly into... > +then this tells @value{GDBN} to go into it's handshaking mode with the ^^^^ This should be "its", without the apostrophe. > +it supports. The term "stable MI protocol" simply means that the protocol Please use ``this style'' to quote phrases in Texinfo (the result is prettier in the printed version). Actually, in this case, since you are introducing a new term, I'd suggest to say The term @dfn{stable MI protocol} simply means... Also, a @cindex entry here about stable MI protocol would be useful. > +untested protocols, they could simply try to invoke @value{GDBN} with -i=miN, > +where N is version they wish to communicate with. Please use @var{n} instead of a literal "N" here. > +If a specific version of @value{GDBN} speaks only one stable MI protocol than The last woprd should be "then", not "than". > +versions of the MI protocol, than it will output a list of these protocols ^^^^ Again, "then". Other than these few minor problems, the documentation patch is approved. Thanks.