diff mbox

[v3,6/6] Rename python function thread_from_thread_handle to thread_from_handle

Message ID 20190321100907.2ffb49f5@f29-4.lan
State New
Headers show

Commit Message

Kevin Buettner March 21, 2019, 5:09 p.m. UTC
On Thu, 21 Mar 2019 16:21:40 +0200
Eli Zaretskii <eliz@gnu.org> wrote:

> > Date: Wed, 20 Mar 2019 21:51:55 -0700
> > From: Kevin Buettner <kevinb@redhat.com>
> > Cc: Eli Zaretskii <eliz@gnu.org>
> > 
> > gdb/doc/ChangeLog:
> > 
> > 	* python.texi (Inferiors In Python): Rename
> > 	Inferior.thread_from_thread_handle to Inferior.thread_from_handle.
> > 	Add note about the former being deprecated.  
> 
> This part is OK, with one comment:
> 
> > -@findex Inferior.thread_from_thread_handle  
> 
> Please don't remove this index entry, it will be useful for someone
> who sees code which uses the deprecated name and wants to know what
> that is.

I was wondering about that when I made the change.  I've restored the
index entry in my local sources.  Here's what that part of it looks like
now:

Comments

Eli Zaretskii March 21, 2019, 6:26 p.m. UTC | #1
> Date: Thu, 21 Mar 2019 10:09:07 -0700
> From: Kevin Buettner <kevinb@redhat.com>
> Cc: Eli Zaretskii <eliz@gnu.org>
> 
> > > -@findex Inferior.thread_from_thread_handle  
> > 
> > Please don't remove this index entry, it will be useful for someone
> > who sees code which uses the deprecated name and wants to know what
> > that is.
> 
> I was wondering about that when I made the change.  I've restored the
> index entry in my local sources.  Here's what that part of it looks like
> now:

LGTM, thanks.
diff mbox

Patch

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 2a5a5cde3d..ab191b620c 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -2906,11 +2906,16 @@  containing the address where the pattern was found, or @code{None} if
 the pattern could not be found.
 @end defun
 
+@findex Inferior.thread_from_handle
 @findex Inferior.thread_from_thread_handle
-@defun Inferior.thread_from_thread_handle (thread_handle)
-Return the thread object corresponding to @var{thread_handle}, a thread
+@defun Inferior.thread_from_handle (handle)
+Return the thread object corresponding to @var{handle}, a thread
 library specific data structure such as @code{pthread_t} for pthreads
 library implementations.
+
+The function @code{Inferior.thread_from_thread_handle} provides
+the same functionality, but use of @code{Inferior.thread_from_thread_handle}
+is deprecated.
 @end defun
 
 @node Events In Python