This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
[PATCH 4/4] Documentation for python method InferiorThread.thread_handle
- From: Kevin Buettner <kevinb at redhat dot com>
- To: gdb-patches at sourceware dot org
- Date: Sat, 15 Sep 2018 22:18:47 -0700
- Subject: [PATCH 4/4] Documentation for python method InferiorThread.thread_handle
- References: <20180915220836.7dda4a63@pinnacle.lan>
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(+)
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index aca6ec8..87e1762 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -3220,6 +3220,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 (type)
+Return the thread object's handle. Since handles are generally opaque
+objects, the type @var{type} is used to ensure that the correct amount
+of space is allocated for the returned handle value. When using handles
+associated with the pthreads library, the value passed for @var{type}
+should be the result of invoking @code{gdb.lookup_type('pthread_t')}.
+@end defun
+
@node Recordings In Python
@subsubsection Recordings In Python
@cindex recordings in python