This is the mail archive of the gdb-cvs@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]

[binutils-gdb] python: Fix erroneous doc about gdb.objfiles()


https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=74d3fbbb3e35129526392718b63df41be3b0e88b

commit 74d3fbbb3e35129526392718b63df41be3b0e88b
Author: Simon Marchi <simon.marchi@ericsson.com>
Date:   Thu Sep 13 15:41:32 2018 -0400

    python: Fix erroneous doc about gdb.objfiles()
    
    The code implementing gdb.objfiles() returns a list of objfiles for the
    current program space (the program space of the selected inferior).  The
    documentation for the gdb.objfiles() Python method, however, states:
    
        Return a sequence of all the objfiles current known to GDB.
    
    That sounds wrong to me.  I tried to phrase to be more precise.
    
    gdb/doc/ChangeLog:
    
    	* python.texi (Objfiles In Python): Update gdb.objfiles() doc.

Diff:
---
 gdb/doc/ChangeLog   | 4 ++++
 gdb/doc/python.texi | 8 ++++----
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index e6d5c8f..1a5c70b 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,4 +1,8 @@
 2018-09-13  Simon Marchi  <simon.marchi@ericsson.com>
+
+	* python.texi (Objfiles In Python): Update gdb.objfiles() doc.
+
+2018-09-13  Simon Marchi  <simon.marchi@ericsson.com>
 2018-09-13  Tom Tromey  <tom@tromey.com>
 
 	* python.texi (Program Spaces In Python): Document the
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 896e27b..aca6ec8 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -4112,10 +4112,10 @@ 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}.  This is identical to
-@code{gdb.selected_inferior().progspace.objfiles()} (@pxref{Progspaces In
-Python}) and is included for historical compatibility.
+Return a sequence of objfiles referenced by the current program space.
+@xref{Objfiles In Python}, and @ref{Progspaces In Python}.  This is identical
+to @code{gdb.selected_inferior().progspace.objfiles()} and is included for
+historical compatibility.
 @end defun
 
 @findex gdb.lookup_objfile


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