From: Eli Zaretskii <eliz@gnu.org>
To: Joel Brobecker <brobecker@adacore.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [RFA/commit+doco] GDB/MI: Document support for -exec-run --start in -list-features
Date: Tue, 10 Dec 2013 17:39:00 -0000 [thread overview]
Message-ID: <83eh5ky5b8.fsf@gnu.org> (raw)
In-Reply-To: <20131210120252.GD3238@adacore.com>
> Date: Tue, 10 Dec 2013 13:02:52 +0100
> From: Joel Brobecker <brobecker@adacore.com>
> Cc: gdb-patches@sourceware.org
>
> > @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?
We should do both, I think.
> > 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.
Thanks.
> 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.
"It" being what? the section title or something else? I'm afraid I
don't understand the problem.
> > >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.
Thanks.
next prev parent reply other threads:[~2013-12-10 17:39 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-12-03 6:21 Joel Brobecker
2013-12-03 7:22 ` Eli Zaretskii
2013-12-03 10:18 ` Joel Brobecker
2013-12-10 12:03 ` Joel Brobecker
2013-12-10 17:39 ` Eli Zaretskii [this message]
2013-12-12 16:02 ` pushed: Add @cindex for section documenting the -list-features GDB/MI command. (was: "[RFA/commit+doco] GDB/MI: Document support for -exec-run --start in -list-features") Joel Brobecker
2013-12-12 16:35 ` Eli Zaretskii
2013-12-13 6:10 ` [RFA/commit+doco] GDB/MI: Document support for -exec-run --start in -list-features Joel Brobecker
2013-12-13 15:51 ` Joel Brobecker
2013-12-13 19:36 ` Eli Zaretskii
2013-12-23 1:01 ` Joel Brobecker
2013-12-23 1:40 ` Joel Brobecker
2013-12-23 3:49 ` Eli Zaretskii
2013-12-23 4:28 ` Joel Brobecker
2013-12-23 16:10 ` Eli Zaretskii
2013-12-28 3:10 ` pushed: " Joel Brobecker
2013-12-10 11:14 ` Joel Brobecker
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83eh5ky5b8.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=brobecker@adacore.com \
--cc=gdb-patches@sourceware.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox