From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 21284 invoked by alias); 10 Dec 2013 12:03:03 -0000 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 Received: (qmail 21272 invoked by uid 89); 10 Dec 2013 12:03:03 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-1.0 required=5.0 tests=AWL,BAYES_00 autolearn=ham version=3.3.2 X-HELO: rock.gnat.com Received: from Unknown (HELO rock.gnat.com) (205.232.38.15) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with (AES256-SHA encrypted) ESMTPS; Tue, 10 Dec 2013 12:03:01 +0000 Received: from localhost (localhost.localdomain [127.0.0.1]) by filtered-rock.gnat.com (Postfix) with ESMTP id 591D11165E8; Tue, 10 Dec 2013 07:03:32 -0500 (EST) Received: from rock.gnat.com ([127.0.0.1]) by localhost (rock.gnat.com [127.0.0.1]) (amavisd-new, port 10024) with LMTP id czTZK7ikk0vw; Tue, 10 Dec 2013 07:03:32 -0500 (EST) Received: from joel.gnat.com (localhost.localdomain [127.0.0.1]) by rock.gnat.com (Postfix) with ESMTP id 2C07D1165DC; Tue, 10 Dec 2013 07:03:32 -0500 (EST) Received: by joel.gnat.com (Postfix, from userid 1000) id 30FB5E059F; Tue, 10 Dec 2013 13:02:52 +0100 (CET) Date: Tue, 10 Dec 2013 12:03:00 -0000 From: Joel Brobecker To: Eli Zaretskii Cc: gdb-patches@sourceware.org Subject: Re: [RFA/commit+doco] GDB/MI: Document support for -exec-run --start in -list-features Message-ID: <20131210120252.GD3238@adacore.com> References: <1386051670-28637-1-git-send-email-brobecker@adacore.com> <83wqjm4cwl.fsf@gnu.org> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="BXVAT5kNtrzKuDFl" Content-Disposition: inline In-Reply-To: <83wqjm4cwl.fsf@gnu.org> User-Agent: Mutt/1.5.21 (2010-09-15) X-SW-Source: 2013-12/txt/msg00369.txt.bz2 --BXVAT5kNtrzKuDFl Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-length: 1951 Hello Eli, > > gdb/doc/ChangeLog: > > > > * gdb.texinfo (GDB/MI Miscellaneous Commands): Document the new > > "exec-run-start-option" entry in the output of the "-list-features" > > command. [...] > You have my approval, with one comment: each one of the items in that > @table in gdb.texinfo should be indexed, to facilitate their > discoverability by readers. E.g., for this item I'd suggest > > @findex exec-run-start-option > @cindex support for @option{--start} option in @code{-exec-run} I can add the @findex for each item in the list. However, can you explain why the @cindex. ISTM that it might be better to cross-reference this element from the part of the manual that documents the actual feature? Otherwise, someone looking at the index on how to "start" a program with GDB/MI might find this index entry, follow it, only to find how to check for the feature, not how to use it. WDYT? > I'd also add an index entry for the entire section > > @cindex supported @sc{gdb/mi} features, list Attached is a patch that does that. Incidentally, I've been meaning to talk about a small nit: Why are we adding the anchors and indexing commands after the @section/node/etc? When you click on the reference, the browser jumps to the text, but because the anchor if after the section title, we're not seeing it. For now, I've been consistent with the current practice... > >From the past couple of weeks, it sounds like this section will grow > very fast (so maybe it should become a full-fledged @node). After further consideration, and despite the fact that I said that the list might not grow that fast, I still tend to agree with you. I'll do that next. I think we should extract the text out of the "misc[...]" node, and move it up to its own node. gdb/doc/ChangeLog: * gdb.texinfo (GDB/MI Miscellaneous Commands): Add @cindex entry for section docuumenting the -list-features GDB/MI command. Thanks, -- Joel --BXVAT5kNtrzKuDFl Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="0001-Add-cindex-for-section-documenting-the-list-features.patch" Content-length: 907 >From 1fd741c48e1466440fc0e2372c6484e292c2a54c Mon Sep 17 00:00:00 2001 From: Joel Brobecker Date: Tue, 10 Dec 2013 12:51:38 +0100 Subject: [PATCH] Add @cindex for section documenting the -list-features GDB/MI command. gdb/doc/ChangeLog: * gdb.texinfo (GDB/MI Miscellaneous Commands): Add @cindex entry for section docuumenting the -list-features GDB/MI command. --- gdb/doc/gdb.texinfo | 1 + 1 file changed, 1 insertion(+) diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index 7dfa9f6..d7c90f5 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -35208,6 +35208,7 @@ to the debugger: @subheading The @code{-list-features} Command @findex -list-features +@cindex supported @sc{gdb/mi} features, list Returns a list of particular features of the MI protocol that this version of gdb implements. A feature can be a command, -- 1.8.1.2 --BXVAT5kNtrzKuDFl--