[1/4] gdb/doc: update the 'enabled' field's description for BP locations in MI

Message ID 8895692d5366d94633391a459b7f94fb9a4eda64.1617806598.git.tankut.baris.aktemur@intel.com
State New
Headers show
Series
  • Multi-context invalid breakpoint conditions and MI
Related show

Commit Message

Lancelot SIX via Gdb-patches April 7, 2021, 2:55 p.m.
Update the document to mention the "N*" value for the 'enabled' field
of breakpoint locations.  Also remove the line about the 'enable'
field, because there is no such field for locations.

gdb/doc/ChangeLog:
2021-04-06  Tankut Baris Aktemur  <tankut.baris.aktemur@intel.com>

	* gdb.texinfo (GDB/MI Breakpoint Information): Update the
	description for the 'enabled' field of breakpoint locations.
---
 gdb/doc/gdb.texinfo | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

-- 
2.17.1

Comments

Lancelot SIX via Gdb-patches April 7, 2021, 3:15 p.m. | #1
> Date: Wed,  7 Apr 2021 16:55:56 +0200

> From: Tankut Baris Aktemur via Gdb-patches <gdb-patches@sourceware.org>

> 

>  @item enabled

>  This indicates whether the location is enabled, in which case the

> -value is @samp{y}, or disabled, in which case the value is @samp{n}.

> -Note that this is not the same as the field @code{enable}.

> +value is @samp{y}, or disabled by the user, in which case the value

> +is @samp{n}, or disabled because the breakpoint condition is invalid

> +at this location, in which case the value is @samp{N*}.


This is better formatted as a @table.  Trying ti squeeze all of the
possible values into a single sentence runs a high risk of producing a
complex and confusing sentence.

Thanks.
Lancelot SIX via Gdb-patches April 7, 2021, 9:42 p.m. | #2
On 2021-04-07 10:55 a.m., Tankut Baris Aktemur via Gdb-patches wrote:
> Update the document to mention the "N*" value for the 'enabled' field

> of breakpoint locations.  Also remove the line about the 'enable'

> field, because there is no such field for locations.


Hi Baris,

The asterisk in N* exists because it refers to the bottom note in the
CLI output:

    (gdb) i b
    Num     Type           Disp Enb Address            What
    1       breakpoint     keep y   <MULTIPLE>
            stop only if patate == 2
    1.1                         N*  0x00000000000011f7 in main at test.c:27
    (*): Breakpoint condition is invalid at this location.

If we didn't have that bottom note, I suppose the value would simply be
"N" (and it would be very cryptic for CLI users).

So I think it would make sense that for MI, we only output "N" as the
enabled value, instead of "N*".

Simon

Patch

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 7dbffb65d53..bfac2b6d245 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -30048,8 +30048,9 @@  location within that breakpoint.
 
 @item enabled
 This indicates whether the location is enabled, in which case the
-value is @samp{y}, or disabled, in which case the value is @samp{n}.
-Note that this is not the same as the field @code{enable}.
+value is @samp{y}, or disabled by the user, in which case the value
+is @samp{n}, or disabled because the breakpoint condition is invalid
+at this location, in which case the value is @samp{N*}.
 
 @item addr
 The address of this location as an hexidecimal number.