[3/4] Documentation for gdb.thread_from_thread_handle

Message ID 20160505141647.65c13e73@pinnacle.lan
State New, archived
Headers

Commit Message

Kevin Buettner May 5, 2016, 9:16 p.m. UTC
  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(+)
  

Comments

Eli Zaretskii May 6, 2016, 6:31 a.m. UTC | #1
> 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?
  
Eli Zaretskii May 6, 2016, 6:32 a.m. UTC | #2
> 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.
  

Patch

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
+
 A @code{gdb.InferiorThread} object has the following attributes:
 
 @defvar InferiorThread.name