Re: [PATCH v3 4/4] gdb/doc: document '+' argument for 'list' command

Bruno Larsen via Gdb-patches
2023-06-21T12:55:51Z

On 21/06/2023 14:44, Eli Zaretskii wrote:
>> Date: Wed, 21 Jun 2023 13:20:54 +0200
>> Cc: gdb-patches@sourceware.org
>> From: Bruno Larsen <blarsen@redhat.com>
>>
>> On 21/06/2023 13:13, Eli Zaretskii wrote:
>>>> \"list .\" lists ten lines arond where the inferior is stopped.\n\
>>>> +\"list +\" lists the ten lines following a previous ten-line listing.\n\
>>>> \"list -\" lists the ten lines before a previous ten-line listing.\n\
>>>> One argument specifies a line, and ten lines are listed around that line.\n\
>>>> Two arguments with comma between specify starting and ending lines to list.\n\
>>> This part is OK.
>>>
>>>> diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
>>>> index e4e374d138c..f9c3c90e16a 100644
>>>> --- a/gdb/doc/gdb.texinfo
>>>> +++ b/gdb/doc/gdb.texinfo
>>>> @@ -9149,6 +9149,10 @@ Stack}), this prints lines centered around that line. If no
>>>> @code{list} command has been used and no solitary line was printed,
>>>> it prints the lines around the function @code{main}.
>>>>
>>>> +@item list +
>>>> +Same as using with no arguments, but errors out if the line is
>>>> +past the end of the file.
>>> But here it looks like some copy/pasta error?
>>>
>> No, this is the main distinguishing feature between "list" and "list +",
>> the latter will error out if it is past the end of the file, while the
>> former won't.
> But then these two descriptions of "list +" describe two
> seemingly-different behaviors:
>
> "list +" lists the ten lines following a previous ten-line listing.
>
> vs
>
> @item list +
> Same as using with no arguments, but errors out if the line is
> past the end of the file.
>
> Or what am I missing?
>
Ah, I see what you mean. I thought that the help text should prioritize
being short over being complete, and I basically modeled it after the
no-arguments help text (With no argument, lists ten more lines after or
around previous listing) whereas the documentation I thought was
important outlining the difference.

Would you prefer if I made the help text more verbose?

--
Cheers,
Bruno