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 --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index e6d5c8f09cc077c8e0b25d0531c249f5f97a4a87..1a5c70bfc803d5ee6296f93a46fa0d5f912ae4ec 100644 (file)
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,7 @@
+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>
 

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 896e27b48912d9245ed60b8fa370c780a87e0c06..aca6ec858cf62b2e2a68fde64e71d0e723950fda 100644 (file)
--- 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