This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [RFA 01/12] Fix help and documentation for inferior commands
- From: Pedro Alves <palves at redhat dot com>
- To: Eli Zaretskii <eliz at gnu dot org>, Tom Tromey <tom at tromey dot com>
- Cc: gdb-patches at sourceware dot org
- Date: Fri, 4 May 2018 19:07:40 +0100
- Subject: Re: [RFA 01/12] Fix help and documentation for inferior commands
- References: <20180430143731.30007-1-tom@tromey.com> <20180430143731.30007-2-tom@tromey.com> <837eoosokt.fsf@gnu.org>
On 04/30/2018 04:26 PM, Eli Zaretskii wrote:
>> From: Tom Tromey <tom@tromey.com>
>> Cc: Tom Tromey <tom@tromey.com>
>> Date: Mon, 30 Apr 2018 08:37:20 -0600
>>
>> While doing this I noticed that the manual doesn't document the
>> argument to "info inferiors", so I've added that as well.
>
> Thanks.
>
>> @table @code
>> -@kindex info inferiors
>> +@kindex info inferiors [ @var{ID}@dots{} ]
>
> "ID" should be in lower-case. (It will be rendered in caps in Info,
> but not in the printed output, where it will be typeset in the slant
> typeface.)
>
>> +By default all inferiors are printed, but an argument can be used to
>> +limit the display to just the requested inferiors.
>
> This should reference @var{id} and explain what the "id" there is.
> Someone might think it's a PID, for example.
I think it'll also to good to say that it's a space-separated
list of IDs, like we say in the "info threads" help and documentation.
See thread-id-list / "thread ID lists", and "breakpoint lists" in
the manual for examples.
Thanks,
Pedro Alves