From: Kevin Buettner <kevinb@redhat.com>
Date: Sun, 16 Sep 2018 04:53:38 +0000 (-0700)
Subject: Documentation for python method InferiorThread.handle
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=c369f8f0face23a06e0cf114bf70a024ba9b4959;p=binutils-gdb.git

Documentation for python method InferiorThread.handle

gdb/doc/ChangeLog:

	* python.texi (Threads In Python): Add description for method
	InferiorThread.handle.
---

diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 5a0621e2ceb..a3564abdeb9 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,8 @@
+2019-04-08  Kevin Buettner  <kevinb@redhat.com>
+
+	* python.texi (Threads In Python): Add description for method
+	InferiorThread.handle.
+
 2019-04-07  Tom Tromey  <tom@tromey.com>
 
 	* Makefile.in (all): Depend on "info".
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 67165ac3ba8..6a967ec26c2 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -3334,6 +3334,14 @@ Return a Boolean indicating whether the thread is running.
 Return a Boolean indicating whether the thread is exited.
 @end defun
 
+@defun InferiorThread.handle ()
+Return the thread object's handle, represented as a Python @code{bytes}
+object.  A @code{gdb.Value} representation of the handle may be
+constructed via @code{gdb.Value(bufobj, type)} where @var{bufobj} is
+the Python @code{bytes} representation of the handle and @var{type} is
+a @code{gdb.Type} for the handle type.
+@end defun
+
 @node Recordings In Python
 @subsubsection Recordings In Python
 @cindex recordings in python