This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [PATCH 3/4] Documentation for gdb.thread_from_thread_handle
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Kevin Buettner <kevinb at redhat dot com>
- Cc: gdb-patches at sourceware dot org
- Date: Fri, 06 May 2016 09:32:10 +0300
- Subject: Re: [PATCH 3/4] Documentation for gdb.thread_from_thread_handle
- Authentication-results: sourceware.org; auth=none
- References: <20160505140938 dot 26a084ed at pinnacle dot lan> <20160505141647 dot 65c13e73 at pinnacle dot lan>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> Date: Thu, 5 May 2016 14:16:47 -0700
> From: Kevin Buettner <kevinb@redhat.com>
>
> gdb/doc/ChangeLog:
>
> * python.texi (Threads In Python): Add description for function
> gdb.thread_from_thread_handle.
> ---
> gdb/doc/python.texi | 7 +++++++
> 1 file changed, 7 insertions(+)
>
> diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
> index ffbf89a..c519d1c 100644
> --- a/gdb/doc/python.texi
> +++ b/gdb/doc/python.texi
> @@ -2981,6 +2981,13 @@ This function returns the thread object for the selected thread. If there
> is no selected thread, this will return @code{None}.
> @end defun
>
> +@findex gdb.thread_from_thread_handle
> +@defun gdb.thread_from_thread_handle
> +Return the thread object corresponding to the thread handle,
> +@var{thread_handle}, a thread library specific data structure such as
> +@code{pthread_t} for pthreads library implementations.
> +@end defun
Thanks. But should the @defun line include thread_handle as well?
It's the argument of the method, right?
Also, @defun automatically places its argument in the function index,
so @findex is not needed.