From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 29616 invoked by alias); 30 May 2006 19:28:37 -0000 Received: (qmail 29588 invoked by uid 22791); 30 May 2006 19:28:35 -0000 X-Spam-Check-By: sourceware.org Received: from gandalf.inter.net.il (HELO gandalf.inter.net.il) (192.114.186.17) by sourceware.org (qpsmtpd/0.31) with ESMTP; Tue, 30 May 2006 19:28:12 +0000 Received: from nitzan.inter.net.il (nitzan.inter.net.il [192.114.186.20]) by gandalf.inter.net.il (MOS 3.7.1-GA) with ESMTP id IVG54014; Tue, 30 May 2006 22:27:59 +0300 (IDT) Received: from HOME-C4E4A596F7 (IGLD-83-130-252-174.inter.net.il [83.130.252.174]) by nitzan.inter.net.il (MOS 3.7.3-GA) with ESMTP id DNM18050 (AUTH halo1); Tue, 30 May 2006 22:27:55 +0300 (IDT) Date: Wed, 31 May 2006 01:20:00 -0000 Message-Id: From: Eli Zaretskii To: Nick Roberts CC: gdb-patches@sources.redhat.com In-reply-to: <17531.61787.895726.198461@kahikatea.snap.net.nz> (message from Nick Roberts on Tue, 30 May 2006 19:16:43 +1200) Subject: Re: {PATCH] MI Doco [was Re: CLI and GDB/MI...] Reply-to: Eli Zaretskii References: <17509.54397.736467.479414@kahikatea.snap.net.nz> <17509.943.40875.198555@farnswood.snap.net.nz> <20060512221531.GA1741@brasko.net> <17510.62256.102468.268003@kahikatea.snap.net.nz> <20060513154631.GA4941@nevyn.them.org> <17531.61787.895726.198461@kahikatea.snap.net.nz> X-IsSubscribed: yes Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org X-SW-Source: 2006-05/txt/msg00475.txt.bz2 > From: Nick Roberts > Date: Tue, 30 May 2006 19:16:43 +1200 > Cc: gdb-patches@sources.redhat.com > > OK, here's something along these lines. Its a bit incomplete but it might > be good to put something in now, and develop it as our ideas crystallise. Thanks. I have a few comments and suggestions: > + @node GDB/MI Development and Front Ends > + @section @sc{gdb/mi} Development and Front Ends > + > + The application which takes the MI output and presents the state of the > + program being debugged to the user is called a @dfn{front end}. Please add a @cindex entry here. The text can be the name of the section, or some permutation thereof. > + section tries to minimise the problems by describing how the protocol "minimize", please. We use the US spelling. > + If the changes are such that is considered likely that they would > + necessarily break a front end I think the following is simpler and more clear: If changes are accumulated that are likely to break front ends, ... > + to the MI version. Apart from mi0, new versions of GDB will not Please use "@value{GDBN}" instead of a literal "GDB". > + The best way to ensure that unexpected changes which break your front > + end are not made is The best way to avoid changes in MI that might unexpectedly break your front end is ... > is to make your project known to GDB developers and > + follow development on @email{gdb@@sources.redhat.com} and > + @email{gdb-patches@@sources.redhat.com}. There is also the mailing list > + @email{dmi-discuss@@lists.freestandards.org}, hosted by the Free Standards > + Group, which has the aim of creating a a more general MI protocol > + called Debugger Machine Interface (DMI) that will become a standard > + for all debuggers, not just GDB. I suggest an index entry here, something like @cindex @sc{gdb/mi} development, mailing lists