[1/9] gdb/doc: extend the description for Progspace.filename
Checks
Context |
Check |
Description |
linaro-tcwg-bot/tcwg_gdb_build--master-aarch64 |
success
|
Testing passed
|
linaro-tcwg-bot/tcwg_gdb_build--master-arm |
success
|
Testing passed
|
linaro-tcwg-bot/tcwg_gdb_check--master-arm |
success
|
Testing passed
|
linaro-tcwg-bot/tcwg_gdb_check--master-aarch64 |
success
|
Testing passed
|
Commit Message
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.
---
gdb/doc/python.texi | 7 ++++++-
gdb/python/py-progspace.c | 2 +-
2 files changed, 7 insertions(+), 2 deletions(-)
Comments
> Date: Sat, 16 Sep 2023 11:18:02 +0100
> From: Andrew Burgess via Gdb-patches <gdb-patches@sourceware.org>
>
> 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.
> ---
> gdb/doc/python.texi | 7 ++++++-
> gdb/python/py-progspace.c | 2 +-
> 2 files changed, 7 insertions(+), 2 deletions(-)
The python.texi part is approved, thanks.
Reviewed-By: Eli Zaretskii <eliz@gnu.org>
@@ -5034,7 +5034,12 @@
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
@@ -572,7 +572,7 @@ static gdb_PyGetSetDef pspace_getset[] =
{ "__dict__", gdb_py_generic_dict, NULL,
"The __dict__ for this progspace.", &pspace_object_type },
{ "filename", pspy_get_filename, NULL,
- "The progspace's main filename, or None.", NULL },
+ "The filename of the progspace's main symbol file, or None.", nullptr },
{ "pretty_printers", pspy_get_printers, pspy_set_printers,
"Pretty printers.", NULL },
{ "frame_filters", pspy_get_frame_filters, pspy_set_frame_filters,