public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Tom Tromey <tom@tromey.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [RFA 01/12] Fix help and documentation for inferior commands
Date: Thu, 10 May 2018 09:17:00 -0000	[thread overview]
Message-ID: <83603wp7g7.fsf@gnu.org> (raw)
In-Reply-To: <87po244lp3.fsf@tromey.com> (message from Tom Tromey on Wed, 09	May 2018 14:29:28 -0600)

> From: Tom Tromey <tom@tromey.com>
> Cc: Tom Tromey <tom@tromey.com>,  gdb-patches@sourceware.org
> Date: Wed, 09 May 2018 14:29:28 -0600
> 
> >> @table @code
> >> -@kindex info inferiors
> >> +@kindex info inferiors [ @var{ID}@dots{} ]
> 
> Eli> "ID" should be in lower-case.  (It will be rendered in caps in Info,
> Eli> but not in the printed output, where it will be typeset in the slant
> Eli> typeface.)
> 
> >> +By default all inferiors are printed, but an argument can be used to
> >> +limit the display to just the requested inferiors.
> 
> Eli> This should reference @var{id} and explain what the "id" there is.
> Eli> Someone might think it's a PID, for example.
> 
> How about like this:
> 
>     @kindex info inferiors [ @var{id}@dots{} ]
>     @item info inferiors
>     Print a list of all inferiors currently being managed by @value{GDBN}.
>     By default all inferiors are printed, but the argument -- a space
>     separate list of inferior numbers -- can be used to limit the display
>     to just the requested inferiors.

Yes, thanks.

> This doesn't refer to @var{id} but I didn't see a clean way to do that.

Like this:

  ... but the argument @var{id}@dots{} -- a space separated list ...

(Note: "separated", not "separate".)

  reply	other threads:[~2018-05-10  2:31 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-04-30 14:37 [RFA 00/12] Small help text tweaks Tom Tromey
2018-04-30 14:37 ` [RFA 04/12] Update memattr.c help strings Tom Tromey
2018-05-04 18:16   ` Pedro Alves
2018-05-09 20:35     ` Tom Tromey
2018-05-24 17:53       ` Pedro Alves
2018-04-30 14:37 ` [RFA 11/12] Update help text in linux-fork.c Tom Tromey
2018-05-04 18:56   ` Pedro Alves
2018-04-30 14:37 ` [RFA 01/12] Fix help and documentation for inferior commands Tom Tromey
2018-04-30 15:26   ` Eli Zaretskii
2018-05-04 18:07     ` Pedro Alves
2018-05-09 20:29     ` Tom Tromey
2018-05-10  9:17       ` Eli Zaretskii [this message]
2018-04-30 14:37 ` [RFA 07/12] Update help text for "jump" command Tom Tromey
2018-05-04 18:52   ` Pedro Alves
2018-04-30 14:37 ` [RFA 03/12] Update core-related help strings Tom Tromey
2018-05-04 18:11   ` Pedro Alves
2018-05-09 20:31     ` Tom Tromey
2018-05-24 21:28       ` Pedro Alves
2018-04-30 14:37 ` [RFA 05/12] Update help strings in TUI Tom Tromey
2018-05-04 18:26   ` Pedro Alves
2018-04-30 14:37 ` [RFA 10/12] Update help text in record-btrace.c Tom Tromey
2018-05-04 18:55   ` Pedro Alves
2018-04-30 14:37 ` [RFA 09/12] Update help text in tracepoint.c Tom Tromey
2018-05-04 18:54   ` Pedro Alves
2018-04-30 14:37 ` [RFA 02/12] Update help strings in skip.c Tom Tromey
2018-05-04 18:09   ` Pedro Alves
2018-04-30 14:37 ` [RFA 12/12] Update help text in record.c Tom Tromey
2018-05-04 18:57   ` Pedro Alves
2018-04-30 14:37 ` [RFA 08/12] Update help text in disasm.c Tom Tromey
2018-05-04 18:54   ` Pedro Alves
2018-04-30 14:37 ` [RFA 06/12] Update help text in dcache.c Tom Tromey
2018-05-04 18:27   ` Pedro Alves
2018-04-30 14:40 ` [RFA 00/12] Small help text tweaks Eli Zaretskii
2018-04-30 15:13   ` Tom Tromey

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=83603wp7g7.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=tom@tromey.com \
    /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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).