Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Simon Marchi <simon.marchi@ericsson.com>
To: <gdb-patches@sourceware.org>
Cc: Simon Marchi <simon.marchi@ericsson.com>
Subject: [PATCH 3/3] python: Fix erroneous doc about gdb.objfiles()
Date: Wed, 12 Sep 2018 19:36:00 -0000	[thread overview]
Message-ID: <20180912193617.16523-3-simon.marchi@ericsson.com> (raw)
In-Reply-To: <20180912193617.16523-1-simon.marchi@ericsson.com>

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.
---
 gdb/doc/python.texi | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

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
 
 @findex gdb.lookup_objfile
-- 
2.19.0


  reply	other threads:[~2018-09-12 19:36 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-12 19:37 [PATCH 1/3] python: Add Inferior.progspace property Simon Marchi
2018-09-12 19:36 ` Simon Marchi [this message]
2018-09-12 21:46   ` [PATCH 3/3] python: Fix erroneous doc about gdb.objfiles() Tom Tromey
2018-09-13  2:37   ` Eli Zaretskii
2018-09-13  2:42     ` Simon Marchi
2018-09-12 19:37 ` [PATCH 2/3] python: Add Progspace.objfiles method Simon Marchi
2018-09-12 22:01   ` Tom Tromey
2018-09-12 22:58     ` Simon Marchi
2018-09-13  4:50       ` Tom Tromey
2018-09-13  2:38   ` Eli Zaretskii
2018-09-12 21:42 ` [PATCH 1/3] python: Add Inferior.progspace property Tom Tromey
2018-09-12 22:22   ` Simon Marchi
2018-09-13  4:38     ` Tom Tromey
2018-09-13 22:16       ` Tom Tromey
2018-09-12 21:43 ` Tom Tromey
2018-09-13  2:37 ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180912193617.16523-3-simon.marchi@ericsson.com \
    --to=simon.marchi@ericsson.com \
    --cc=gdb-patches@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox