aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrew Burgess <aburgess@redhat.com>2023-08-28 16:58:12 +0100
committerAndrew Burgess <aburgess@redhat.com>2023-09-28 15:33:13 +0100
commitce65386db6653171334434ae488a0c0e10a60871 (patch)
tree2f3a1a7b6eca19c1f3be5812fe4dab0c78e2fdc7 /gdb/doc/python.texi
parentgdb/x86: use size of XSAVE area of enabled features (diff)
downloadbinutils-gdb-ce65386db6653171334434ae488a0c0e10a60871.tar.gz
binutils-gdb-ce65386db6653171334434ae488a0c0e10a60871.tar.bz2
binutils-gdb-ce65386db6653171334434ae488a0c0e10a60871.zip
gdb/doc: extend the description for Progspace.filename
Extend the description for Progspace.filename in the documentation to mention what the returned string is actually the filename for (e.g. that it is the filename passed to the 'symbol-file' or 'file' command). Also document that this attribute will be None if no symbol file is currently loaded. Reviewed-By: Eli Zaretskii <eliz@gnu.org> Approved-By: Tom Tromey <tom@tromey.com>
Diffstat (limited to 'gdb/doc/python.texi')
-rw-r--r--gdb/doc/python.texi7
1 files changed, 6 insertions, 1 deletions
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 5e88fd09e48..1b4b8a3fa14 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -5070,7 +5070,12 @@ Each progspace is represented by an instance of the @code{gdb.Progspace}
class.
@defvar Progspace.filename
-The file name of the progspace as a string.
+The file name, as a string, of the main symbol file (from which debug
+symbols have been loaded) for the progspace, e.g.@: the argument to
+the @kbd{symbol-file} or @kbd{file} commands.
+
+If there is no main symbol table currently loaded, then this attribute
+will be @code{None}.
@end defvar
@defvar Progspace.pretty_printers