public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Kevin Buettner <kevinb@redhat.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [PATCH 4/4] Documentation for python method InferiorThread.thread_handle
Date: Sun, 16 Sep 2018 16:04:00 -0000	[thread overview]
Message-ID: <83a7ohig3z.fsf@gnu.org> (raw)
In-Reply-To: <20180915221847.27a1d50b@pinnacle.lan> (message from Kevin	Buettner on Sat, 15 Sep 2018 22:18:47 -0700)

> Date: Sat, 15 Sep 2018 22:18:47 -0700
> From: Kevin Buettner <kevinb@redhat.com>
> 
> +@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

The phrase "type TYPE is used ..." is awkward.  I suggest to use just
"@var{type", as the name speaks for itself.

Actually, since we want to avoid passive tense, I'd rephrase

  Since various thread handles have different sizes, a Python program
  should supply a suitable @var{type} argument, to ensure @value{GDBN}
  allocates the correct amount of memory for the handle.  E.g., for
  thread handles associated with the @code{pthreads} library, you
  should use @code{gdb.lookup_type('pthread_t')} for @var{type}.

Thanks.

  reply	other threads:[~2018-09-16 16:04 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-16  5:08 [PATCH 0/4] Add python method gdb.InferiorThread.thread_handle Kevin Buettner
2018-09-16  5:16 ` [PATCH 1/4] Add and implement thread_to_thread_handle Kevin Buettner
2018-09-16  5:17 ` [PATCH 2/4] Add python method gdb.InferiorThread.thread_handle Kevin Buettner
2018-09-16  5:17 ` [PATCH 3/4] Tests for gdb.InfThread.thread_handle Kevin Buettner
2018-09-16  5:19 ` [PATCH 4/4] Documentation for python method InferiorThread.thread_handle Kevin Buettner
2018-09-16 16:04   ` Eli Zaretskii [this message]
2018-09-18 11:16   ` Tom Tromey
2018-09-20  0:03     ` Kevin Buettner
2018-09-18 11:03 ` [PATCH 0/4] Add python method gdb.InferiorThread.thread_handle Tom Tromey
2018-09-19 23:53   ` Kevin Buettner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83a7ohig3z.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=kevinb@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).