[v2,5/5] Documentation for python method InferiorThread.thread_handle

Message ID 20190227193500.3d419ead@f29-4.lan
State Superseded
Headers show
Series
  • Add python method gdb.InferiorThread.thread_handle
Related show

Commit Message

Kevin Buettner Feb. 28, 2019, 2:35 a.m.
gdb/doc/ChangeLog:

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

Comments

Eli Zaretskii Feb. 28, 2019, 6:05 p.m. | #1
> Date: Wed, 27 Feb 2019 19:35:00 -0700

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

> 

> gdb/doc/ChangeLog:

> 

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

> 	InferiorThread.thread_handle.


OK, thanks.

Patch

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 7f6f52c4df..cc663486a2 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.thread_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