From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 12258 invoked by alias); 26 Apr 2008 18:45:08 -0000 Received: (qmail 12244 invoked by uid 22791); 26 Apr 2008 18:45:06 -0000 X-Spam-Check-By: sourceware.org Received: from mtaout4.012.net.il (HELO mtaout4.012.net.il) (84.95.2.10) by sourceware.org (qpsmtpd/0.31) with ESMTP; Sat, 26 Apr 2008 18:44:47 +0000 Received: from HOME-C4E4A596F7 ([84.229.228.217]) by i_mtaout4.012.net.il (HyperSendmail v2004.12) with ESMTPA id <0JZY006XA4NTHHV3@i_mtaout4.012.net.il> for gdb-patches@sources.redhat.com; Sat, 26 Apr 2008 21:57:30 +0300 (IDT) Date: Sat, 26 Apr 2008 19:05:00 -0000 From: Eli Zaretskii Subject: Re: [RFA] [doc] thread-created/thread-exited In-reply-to: <200804262144.03702.vladimir@codesourcery.com> X-012-Sender: halo1@inter.net.il To: Vladimir Prus Cc: gdb-patches@sources.redhat.com Reply-to: Eli Zaretskii Message-id: References: <200804262144.03702.vladimir@codesourcery.com> X-IsSubscribed: yes Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org X-SW-Source: 2008-04/txt/msg00608.txt.bz2 > From: Vladimir Prus > Date: Sat, 26 Apr 2008 21:44:03 +0400 > > This patch documents the thread-create and thread-exited MI notification. > It also fixes the terminology as bit -- the grammar say that out-of-band > record is either async record or stream record, whereas the following docs > first describe stream records and then talk about async records, but call > them out-of-band. > > OK? Did you actually try to say "make info" after applying these patches? Because I don't see how it could fly: you've modified the name of a node, but did not change the corresponding item in the @menu of the section of which "GDB/MI Out-of-band Records" was a subsection. That ought to trigger error messages from makeinfo. > +The following is the list of possible async records A colon at the end of this line, please. > @table @code > @item *stopped,reason="@var{reason}" > +The target has stopped. > +@item =thread-created,id="@var{id}" > +@item =thread-exited,id="@var{id}" > +A thread either was created, or has exited. The @var{id} field > +contains the @var{GDBN} identifier of the thread. > @end table Please leave an empty line before an @item line, otherwise it will look ugly in print. Also, you cannot have 2 @item lines in a row; all but the first one must be @itemx, or else the formatting of the table will come out wrong. Finally, 2 spaces after a period that ends a sentence, please. > +For the @samp{*stopped} async record, the @var{reason} field can have > +one of the following values: > > @table @code > @item breakpoint-hit I'd put this right after the @item above that introduced the `*stopped' record (yes, a table inside a table). Didactically, it is better to have related information close together, rather than apart.