Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Siva Chandra <sivachandra@google.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [Patch v12 1/4] Documentation of the debug method support in GDB Python API
Date: Wed, 02 Apr 2014 02:55:00 -0000	[thread overview]
Message-ID: <831txgcuer.fsf@gnu.org> (raw)
In-Reply-To: <CAGyQ6gw11AoOaOQ_obOAZpCMkQKVCEftm3He+c14YxoM8MowAg@mail.gmail.com>

> 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.


      reply	other threads:[~2014-04-02  2:55 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-04-01 22:52 Siva Chandra
2014-04-02  2:55 ` Eli Zaretskii [this message]

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=831txgcuer.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=sivachandra@google.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