This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [PATCH 1/4 v18] Add xmethod documentation and NEWS entry
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Siva Chandra <sivachandra at google dot com>
- Cc: gdb-patches at sourceware dot org
- Date: Sat, 24 May 2014 10:13:59 +0300
- Subject: Re: [PATCH 1/4 v18] Add xmethod documentation and NEWS entry
- Authentication-results: sourceware.org; auth=none
- References: <CAGyQ6gwiEYCmBRwaiJsK5pyxAhYA6qzQTpebHzSsk+Kque2Mdw at mail dot gmail dot com>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> Date: Fri, 23 May 2014 14:55:01 -0700
> From: Siva Chandra <sivachandra@google.com>
>
> This part was approved (I think) previously but sending it out with
> version synced to v18. Also, the name changed from "debug method" to
> "xmethod". Hence, I think another review is required.
You've got it.
> +@defun XMethodWorker.invoke(self, obj, args)
> +This is the method which does the @emph{work} of the xmethod.
> +@var{obj} is the object on which the method is being invoked, and
> +@var{args} is the tuple of arguments to the method. @var{obj} and the
> +elements of @var{args} are @code{gdb.Value} objects.
It is best not to begin a sentence with "@var{something}", since in
the printed manual that will produce a sentence starting from a
lower-case letter.
Otherwise, OK. Thanks.