diff mbox series

[7/7] Update gdb.Symbol.is_variable documentation

Message ID 20231101-dap-nested-function-v1-7-0b0c3b228ac7@adacore.com
State New
Headers
Series Handle nested functions in DAP |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_gdb_build--master-aarch64 success Testing passed
linaro-tcwg-bot/tcwg_gdb_check--master-aarch64 success Testing passed
linaro-tcwg-bot/tcwg_gdb_check--master-arm success Testing passed
linaro-tcwg-bot/tcwg_gdb_build--master-arm success Testing passed

Commit Message

Tom Tromey Nov. 1, 2023, 5:09 p.m. UTC 
  Kévin found a bug in an earlier version of this series that was based
on a misconception I had about Symbol.is_variable.  This patch fixes
the documentation to explain the method a bit better.
---
 gdb/doc/python.texi | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Eli Zaretskii Nov. 1, 2023, 5:15 p.m. UTC | #1 
> From: Tom Tromey <tromey@adacore.com>
> Date: Wed, 01 Nov 2023 11:09:39 -0600
> 
> Kévin found a bug in an earlier version of this series that was based
> on a misconception I had about Symbol.is_variable.  This patch fixes
> the documentation to explain the method a bit better.
> ---
>  gdb/doc/python.texi | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)

Thanks, this is okay.

Approved-By: Eli Zaretskii <eliz@gnu.org>
diff mbox series

Patch

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index afe447644c5..3a7d61af5a5 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -6045,7 +6045,9 @@  local variables will require a frame, but other symbols will not.
 @end defvar
 
 @defvar Symbol.is_variable
-@code{True} if the symbol is a variable.
+@code{True} if the symbol is a variable, as opposed to something like
+a function or type.  Note that this also returns @code{False} for
+arguments.
 @end defvar
 
 A @code{gdb.Symbol} object has the following methods: