This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH 3/3] python: Fix erroneous doc about gdb.objfiles()


On 2018-09-12 22:36, Eli Zaretskii wrote:
From: Simon Marchi <simon.marchi@ericsson.com>
CC: Simon Marchi <simon.marchi@ericsson.com>
Date: Wed, 12 Sep 2018 15:36:17 -0400

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index abda135e17d..a9de6bd815e 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -4104,8 +4104,9 @@ this function returns @code{None}.

 @findex gdb.objfiles
 @defun gdb.objfiles ()
-Return a sequence of all the objfiles current known to @value{GDBN}.
-@xref{Objfiles In Python}.
+Return a sequence of objfiles for the current program space (and by extension,
+for the selected inferior) @xref{Objfiles In Python} and
+@pxref{Progspaces In Python}.
 @end defun

"By extension" confuses me.  And there should be a period before @xref
and a comma after its closing brace.

Thanks.

Hi Eli,

This changed in the v2 I just sent 5 minutes ago :).

I stole the text from an old patch of Tom, which says

This is identical to gdb.selected_inferior().progspace.objfiles() and is included for historical compatibility.

Which makes what I was trying to say here unnecessary.

Simon


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]