Add a note for how to get the list of threads

Message ID 20191022231900.215822-1-cbiesinger@google.com
State New, archived
Headers

Commit Message

Terekhov, Mikhail via Gdb-patches Oct. 22, 2019, 11:19 p.m. UTC
  It's not immediately obvious how to get the list of threads,
so add a note about that in the "Threads in Python" section.

gdb/doc/ChangeLog:

2019-10-22  Christian Biesinger  <cbiesinger@google.com>

	* python.texi (Threads In Python): Add a note for how to get the
	list of threads.

Change-Id: I0fef8a7aff161fc347c09052319048c907a6e8c3
---
 gdb/doc/python.texi | 3 +++
 1 file changed, 3 insertions(+)
  

Comments

Eli Zaretskii Oct. 23, 2019, 4:24 p.m. UTC | #1
> Date: Tue, 22 Oct 2019 18:19:00 -0500
> From: "Christian Biesinger via gdb-patches" <gdb-patches@sourceware.org>
> Cc: Christian Biesinger <cbiesinger@google.com>
> 
> gdb/doc/ChangeLog:
> 
> 2019-10-22  Christian Biesinger  <cbiesinger@google.com>
> 
> 	* python.texi (Threads In Python): Add a note for how to get the
> 	list of threads.

This is okay, but...

> +To get the list of threads for an inferior, use the @code{Inferior.threads()}
> +method. @xref{Inferiors In Python}
         ^^
...two spaces between sentences, please.

Thanks.
  
Terekhov, Mikhail via Gdb-patches Oct. 23, 2019, 4:28 p.m. UTC | #2
On Wed, Oct 23, 2019 at 11:24 AM Eli Zaretskii <eliz@gnu.org> wrote:
>
> > Date: Tue, 22 Oct 2019 18:19:00 -0500
> > From: "Christian Biesinger via gdb-patches" <gdb-patches@sourceware.org>
> > Cc: Christian Biesinger <cbiesinger@google.com>
> >
> > gdb/doc/ChangeLog:
> >
> > 2019-10-22  Christian Biesinger  <cbiesinger@google.com>
> >
> >       * python.texi (Threads In Python): Add a note for how to get the
> >       list of threads.
>
> This is okay, but...
>
> > +To get the list of threads for an inferior, use the @code{Inferior.threads()}
> > +method. @xref{Inferiors In Python}
>          ^^
> ...two spaces between sentences, please.

Ah, always the hardest style rule for me to remember :( Thanks, fixed
and pushed.

To ssh://sourceware.org/git/binutils-gdb.git
   c12d372d26..14796d2978  HEAD -> master


Christian
  

Patch

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 48adad4e97..a5bc162139 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -3293,6 +3293,9 @@  This function returns the thread object for the selected thread.  If there
 is no selected thread, this will return @code{None}.
 @end defun
 
+To get the list of threads for an inferior, use the @code{Inferior.threads()}
+method. @xref{Inferiors In Python}
+
 A @code{gdb.InferiorThread} object has the following attributes:
 
 @defvar InferiorThread.name