diff options
| author | Kevin Buettner <kevinb@redhat.com> | 2019-03-20 20:38:33 -0700 |
|---|---|---|
| committer | Kevin Buettner <kevinb@redhat.com> | 2019-04-08 20:21:34 -0700 |
| commit | 2b0c8b019996b23fb4717687f5e7ac8c5620c089 (patch) | |
| tree | 27f4cf53d2e1f632def4eea8f081c92bdd22c88c /gdb/doc/python.texi | |
| parent | c369f8f0face23a06e0cf114bf70a024ba9b4959 (diff) | |
| download | binutils-2b0c8b019996b23fb4717687f5e7ac8c5620c089.zip binutils-2b0c8b019996b23fb4717687f5e7ac8c5620c089.tar.gz binutils-2b0c8b019996b23fb4717687f5e7ac8c5620c089.tar.bz2 | |
Rename python function thread_from_thread_handle to thread_from_handle
This renaming was done to stay consistent with the naming of the new
gdb.InferiorThread.handle method. I had initially named it "thread_handle"
but Tom Tromey suggested just "handle".
The old name (thread_from_thread_handle) still works, but is marked as
deprecated in comments in the code as well as in the documentation.
I have some code which uses these functions. I very much like the
brevity of the new names.
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.
gdb/ChangeLog:
* python/py-inferior.c (infpy_thread_from_thread_handle):
Adjust comments to reflect renaming of thread_from_thread_handle
to thread_from_handle. Adjust keywords. Fix type error message.
(inferior_object_methods): Add thread_from_handle. Retain
thread_from_thread_handle, but mark it as deprecated.
testsuite/ChangeLog:
* gdb.python/py-thrhandle.exp: Adjust tests to call
thread_from_handle instead of thread_from_thread_handle.
Diffstat (limited to 'gdb/doc/python.texi')
| -rw-r--r-- | gdb/doc/python.texi | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi index 6a967ec..36947de 100644 --- a/gdb/doc/python.texi +++ b/gdb/doc/python.texi @@ -3000,11 +3000,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 |