Re: [PATCH 1/5] gdb/doc: improve Python Disassembler API documentation

Andrew Burgess via Gdb-patches
2023-04-28T22:50:32Z

Eli Zaretskii <eliz@gnu.org> writes:

>> Cc: Andrew Burgess <aburgess@redhat.com>
>> Date: Tue, 4 Apr 2023 09:21:03 +0100
>> From: Andrew Burgess via Gdb-patches <gdb-patches@sourceware.org>
>>
>> --- a/gdb/doc/python.texi
>> +++ b/gdb/doc/python.texi
>> @@ -6909,7 +6909,7 @@
>> @code{RuntimeError} exception if it is invalid.
>> @end defun
>>
>> -@defun DisassembleInfo.__init__ (info)
>> +@defun DisassembleInfo.__init__ (@var{info})
>
> You consistently rewrite the Texinfo source to use @var inside the
> argument lists of a @defun. I already asked why, as I don't think
> this is required. I don't think you replied. So once again: why are
> you doing this? what problems happen if you don't?

This is an unfortunate consequence of me posting many patches in similar
areas of GDB. All of these landed on the list prior to you enlightening
me that @var is not needed -- it's not me ignoring you.

I should have been more proactive in reviewing my in-flight patches for
this error to avoid wasting your time.

This change will, of course, be removed from this patch.

Thanks for your patience,
Andrew

>
> Otherwise, this is fine. Thanks.
>
> Reviewed-By: Eli Zaretskii <eliz@gnu.org>