From: Tom Tromey <tromey@adacore.com>
Date: Tue, 31 Oct 2023 15:16:08 +0000 (-0600)
Subject: Update gdb.Symbol.is_variable documentation
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=5006ea556dad71c4c868cf5705e007e72e3b02b4;p=binutils-gdb.git

Update gdb.Symbol.is_variable documentation

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.

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

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index c3dfc7ae0fa..b65991bbad0 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -6052,7 +6052,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: