This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [Patch v12 1/4] Documentation of the debug method support in GDB Python API
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Siva Chandra <sivachandra at google dot com>
- Cc: gdb-patches at sourceware dot org
- Date: Wed, 02 Apr 2014 05:55:08 +0300
- Subject: Re: [Patch v12 1/4] Documentation of the debug method support in GDB Python API
- Authentication-results: sourceware.org; auth=none
- References: <CAGyQ6gw11AoOaOQ_obOAZpCMkQKVCEftm3He+c14YxoM8MowAg at mail dot gmail dot com>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> Date: Tue, 1 Apr 2014 15:52:46 -0700
> From: Siva Chandra <sivachandra@google.com>
>
> Siva> +The @value{GDBN} Python API provides classes, interfaces and functions
> Siva> +to implement, register and manipulate debug methods. The core concepts
> Siva> +involved in implementing debug methods are @emph{debug method matchers}
> Siva> +and @emph{debug method workers}.
>
> Eli> The last sentence is a repetition of what the previous section said.
> Eli> Do we really need this here?
>
> I can remove the repetitive sentence. However, for the HTML version of
> the manual with each node on its own page, the repetition makes the
> page self contained (I think).
You can put a cross-reference to that other node.
> Siva> +An instance of @code{DebugMethodMatcher} has the following attributes:
> Siva> +
> Siva> +@defvar DebugMethodMatcher.name
> Siva> +The name of the matcher.
> Siva> +@end defvar
>
> Eli> I think we use only the attribute name, without the class name.
>
> Are you referring to 'DebugMethodMatcher.name'? I find that other
> Python types are also documented in this fashion.
They are all wrong. The majority doesn't.