Toolchain/binutils-gdb
1
0
Fork 0
forked from Imagelibrary/binutils-gdb
Code Pull Requests Activity

python: Fix erroneous doc about gdb.objfiles()

Browse Source 
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.
This commit is contained in:
Simon Marchi
2018-09-13 15:41:32 -04:00
parent 0ae1a3211a
commit 74d3fbbb3e
2 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
gdb/doc/ChangeLog
View File

@@ -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>

8
gdb/doc/python.texi
View File

@@ -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