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

Message ID 20190404165854.17343-6-kevinb@redhat.com
State New
Headers show
Series
  • Add python method gdb.InferiorThread.handle
Related show

Commit Message

Kevin Buettner April 4, 2019, 4:58 p.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(+)

-- 
2.20.1

Patch

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 67165ac3ba..6a967ec26c 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