Re: [PATCHv3 06/15] gdb/tui: add a tui debugging flag

[Andrew Burgess <aburgess@redhat.com>]

Eli Zaretskii via Gdb-patches <gdb-patches@sourceware.org> writes:

>> Date: Mon,  7 Mar 2022 22:13:38 +0000
>> From: Andrew Burgess via Gdb-patches <gdb-patches@sourceware.org>
>> Cc: Andrew Burgess <aburgess@redhat.com>
>> 
>> diff --git a/gdb/NEWS b/gdb/NEWS
>> index 1275d967a2d..eb18ac47804 100644
>> --- a/gdb/NEWS
>> +++ b/gdb/NEWS
>> @@ -133,6 +133,10 @@ winwidth
>>    the width of a tui window to be adjusted when windows are laid out
>>    in horizontal mode.
>>  
>> +set debug tui on|off
>> +show debug tui
>> +  Control the display of debug output about GDB's tui.
>> +
>>  * Changed commands
>>  
>>  maint packet
>> diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
>> index 6081aa85af4..60173e07747 100644
>> --- a/gdb/doc/gdb.texinfo
>> +++ b/gdb/doc/gdb.texinfo
>> @@ -29205,6 +29205,17 @@
>>  source text at the next tab stop; the compact display uses only as
>>  much space as is needed for the line numbers in the current file, and
>>  only a single space to separate the line numbers from the source.
>> +
>> +@kindex set debug tui
>> +@item set debug tui @r{[}on|off@r{]}
>> +Turn on or off display of @value{GDBN} internal debug messages relating
>> +to the TUI.
>> +
>> +@kindex show debug tui
>> +@item show debug tui
>> +Show the current status of displaying @value{GDBN} internal debug
>> +messages relating to the TUI.
>> +
>
> The documentation parts are OK, but I wonder whether we should mention
> the caveats you described, at least in NEWS.  I'm aware that we don't
> usually describe known bugs, but since you say this could cause
> crashes, perhaps it justifies an exception?

I don't know if that's really a route we want to start going down.  Why
would this bug deserve a NEWS entry over any other bug?

Additionally, the 'set debug ...' flags are really only used for
maintenance (I really with they were 'maint set debug ...', but they
are what they are).

My motivation for adding this text to the commit message is simply, that
if a bug _was_ reported in this area, and a GDB maintainer tries to
debug it, and they track it back to this commit ... then the commit
message acknowledges that there is an issue here.

Anyway, below is a patch that adds a NEWS entry for this bug.

Let me know your thoughts.

thanks,
Andrew

---

diff --git a/gdb/NEWS b/gdb/NEWS
index 4d282cb37dd..166b7f57353 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -9,6 +9,11 @@
   Python 2.  From GDB 13, it will only be possible to build GDB itself
   with Python 3 support.
 
+* Bug PR gdb/28948 exists, this can cause GDB to crash when logging
+  redirection is enabled, and the TUI interface is enabled and
+  disabled. See the following link for more details:
+  https://sourceware.org/bugzilla/show_bug.cgi?id=28948
+
 * Improved C++ template support
 
   GDB now treats functions/types involving C++ templates like it does function