From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 16234 invoked by alias); 26 Apr 2008 18:57:10 -0000 Received: (qmail 16224 invoked by uid 22791); 26 Apr 2008 18:57:09 -0000 X-Spam-Check-By: sourceware.org Received: from main.gmane.org (HELO ciao.gmane.org) (80.91.229.2) by sourceware.org (qpsmtpd/0.31) with ESMTP; Sat, 26 Apr 2008 18:56:49 +0000 Received: from list by ciao.gmane.org with local (Exim 4.43) id 1JppZi-0006oQ-JO for gdb-patches@sources.redhat.com; Sat, 26 Apr 2008 18:56:42 +0000 Received: from 78.158.192.230 ([78.158.192.230]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Sat, 26 Apr 2008 18:56:42 +0000 Received: from vladimir by 78.158.192.230 with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Sat, 26 Apr 2008 18:56:42 +0000 To: gdb-patches@sources.redhat.com From: Vladimir Prus Subject: Re: [RFA] [doc] thread-created/thread-exited Date: Sat, 26 Apr 2008 22:23:00 -0000 Message-ID: References: <200804262144.03702.vladimir@codesourcery.com> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="nextPart7353508.9sHgp8aNPW" Content-Transfer-Encoding: 7Bit User-Agent: KNode/0.10.5 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/msg00610.txt.bz2 --nextPart7353508.9sHgp8aNPW Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8Bit Content-length: 2015 Eli Zaretskii wrote: >> 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. I did 'make pdf' and it worked. >> +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. Hmm, it looks just fine for me. I've added blank lines though. > 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. How about this revision? - Volodya --nextPart7353508.9sHgp8aNPW Content-Type: text/x-diff; name="a.diff" Content-Transfer-Encoding: 8Bit Content-Disposition: attachment; filename="a.diff" Content-length: 2096 diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index 294276c..2ffdc53 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -18045,7 +18045,7 @@ follow development on @email{gdb@@sourceware.org} and @menu * GDB/MI Result Records:: * GDB/MI Stream Records:: -* GDB/MI Out-of-band Records:: +* GDB/MI Async Records:: @end menu @node GDB/MI Result Records @@ -18113,24 +18113,23 @@ The log stream contains debugging messages being produced by @value{GDBN}'s internals. @end table -@node GDB/MI Out-of-band Records -@subsection @sc{gdb/mi} Out-of-band Records +@node GDB/MI Async Records +@subsection @sc{gdb/mi} Async Records -@cindex out-of-band records in @sc{gdb/mi} -@cindex @sc{gdb/mi}, out-of-band records -@dfn{Out-of-band} records are used to notify the @sc{gdb/mi} client of +@cindex async records in @sc{gdb/mi} +@cindex @sc{gdb/mi}, async records +@dfn{Async} records are used to notify the @sc{gdb/mi} client of additional changes that have occurred. Those changes can either be a -consequence of @sc{gdb/mi} (e.g., a breakpoint modified) or a result of +consequence of @sc{gdb/mi} commands (e.g., a breakpoint modified) or a result of target activity (e.g., target stopped). -The following is a preliminary list of possible out-of-band records. -In particular, the @var{exec-async-output} records. +The following is the list of possible async records @table @code -@item *stopped,reason="@var{reason}" -@end table -@var{reason} can be one of the following: +@item *stopped,reason="@var{reason}" +The target has stopped. The @var{reason} field can have one of the +following values: @table @code @item breakpoint-hit @@ -18160,6 +18159,13 @@ The inferior exited normally. A signal was received by the inferior. @end table +@item =thread-created,id="@var{id}" +@itemx =thread-exited,id="@var{id}" +A thread either was created, or has exited. The @var{id} field +contains the @value{GDBN} identifier of the thread. +@end table + + @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @node GDB/MI Simple Examples --nextPart7353508.9sHgp8aNPW--