This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[Patch v12 1/4] Documentation of the debug method support in GDB Python API


This part adds the docs and NEWS entries.  I addressed all of Eli's
and Doug's comments barring the following:

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

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.

2014-04-01  Siva Chandra Reddy  <sivachandra@google.com>

        * NEWS (Python Scripting): Add entry about this new feature.

        doc/
        *  python.texi (Debug Methods In Python): New node.
        (Debug Method API): Likewise.
        (Writing a Debug Method): Likewise.

Attachment: dm_docs_v12.txt
Description: Text document


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]