Re: [RFA 01/12] Fix help and documentation for inferior commands

[Eli Zaretskii <eliz at gnu dot org>]

> 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".)