[v3,5/6] Documentation for python method InferiorThread.handle

Message ID 20190320214926.16b85228@f29-4.lan
State Superseded
Headers show
Series
  • Add python method gdb.InferiorThread.handle
Related show

Commit Message

Kevin Buettner March 21, 2019, 4:49 a.m.
gdb/doc/ChangeLog:

	* python.texi (Threads In Python): Add description for method
	InferiorThread.handle.
---
 gdb/doc/python.texi | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Eli Zaretskii March 21, 2019, 2:19 p.m. | #1
> Date: Wed, 20 Mar 2019 21:49:26 -0700

> From: Kevin Buettner <kevinb@redhat.com>

> 

> gdb/doc/ChangeLog:

> 

> 	* python.texi (Threads In Python): Add description for method

> 	InferiorThread.handle.


Thanks, this part is OK.

Patch

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index b02a154ce1..2a5a5cde3d 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -3240,6 +3240,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