Re: [PATCH 8/9] gdb/python: make the executable_changed event available from Python

[Andrew Burgess <aburgess@redhat.com>]

Eli Zaretskii <eliz@gnu.org> writes:

>> Date: Sat, 16 Sep 2023 11:18:09 +0100
>> From: Andrew Burgess via Gdb-patches <gdb-patches@sourceware.org>
>> 
>>  gdb/NEWS                                  |   5 ++
>>  gdb/doc/python.texi                       |  32 +++++++
>>  gdb/python/py-all-events.def              |   1 +
>>  gdb/python/py-event-types.def             |   5 ++
>>  gdb/python/py-progspace.c                 |  54 ++++++++++++
>>  gdb/testsuite/gdb.python/py-exec-file.exp | 100 ++++++++++++++++++++++
>>  6 files changed, 197 insertions(+)
>
> Thanks.
>
>> diff --git a/gdb/NEWS b/gdb/NEWS
>> index 93bc9c6a2c0..10975dbb27b 100644
>> --- a/gdb/NEWS
>> +++ b/gdb/NEWS
>> @@ -297,6 +297,11 @@ info main
>>       exact string passed by the user to these commands; the path will
>>       have been partially resolved to an absolute path.
>>  
>> +  ** A new executable_changed event registry is available.  This event
>> +     emits ExecutableChangedEvent objects, which have 'progspace' (a
>> +     gdb.Progspace) and 'reload' (a Boolean) attributes.  This event
>> +     is emitted when gdb.Progspace.executable_filename changes.
>> +
>>  *** Changes in GDB 13
>
> This part is OK.
>
>> diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
>> index 206cf6b4e18..9f7c7cb076a 100644
>> --- a/gdb/doc/python.texi
>> +++ b/gdb/doc/python.texi
>> @@ -3893,6 +3893,38 @@
>>  The @code{gdb.TargetConnection} that is being removed.
>>  @end defvar
>>  
>> +@item events.executable_changed
>> +Emit @code{gdb.ExecutableChangedEvent} which indicates that the
>> +@code{gdb.Progspace.executable_filename} has changed.
>> +
>> +Changed can mean that either, the value in
>> +@code{gdb.Progspace.executable_filename} has changed to a new path, or
>> +the executable pointed to by @code{gdb.Progspace.executable_filename}
>> +has changed on disk, and @value{GDBN} has reloaded it.
>
> This reads awkwardly, and uses "path" when it means "file name".
> Suggest to rephrase:
>
>   This event is emitted when either the value of
>   @code{gdb.Progspace.executable_filename} has changed to name a
>   different file, or the executable file named by
>   @code{gdb.Progspace.executable_filename} has changed on disk, and
>   @value{GDBN} has therefore reloaded it.
>
>> +@defvar ExecutableChangedEvent.progspace
>> +The @code{gdb.Progspace} in which the current executable has changed.
>> +The path to the updated executable will be visible in
>    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> "The file name of the updated executable..."
>
>> +This attribute will be @code{True} if the value of
>> +@code{gdb.Progspace.executable_filename} didn't change, but the file
>> +pointed to instead changed on disk, and @value{GDBN} reloaded it.
>    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> "...but the file it names changed on disk instead, ...."
>
>> +When this attribute is @code{False}, the value in
>> +@code{gdb.Progspace.executable_filename} was changed to point to a new
>> +file.                                                ^^^^^^^^^^^^^^^^^
>    ^^^^
> "...to name a different file."
>
>> +Remember that @value{GDBN} tracks the executable file, and the symbol
>                                                         ^
> That comma is redundant.
>
> Reviewed-By: Eli Zaretskii <eliz@gnu.org>

Thanks Eli,  I made all the updates you suggested for this series before
pushing it.

Thanks,
Andrew