diff options
| author | Siva Chandra <sivachandra@chromium.org> | 2014-06-09 06:47:22 -0700 |
|---|---|---|
| committer | Siva Chandra <sivachandra@chromium.org> | 2014-06-09 07:19:28 -0700 |
| commit | dd5d5494f4b899b0411fc62c2041ead9cc5e6a53 (patch) | |
| tree | defb6d486d1c9593edcb7678bdb15d6bdad667cc /gdb | |
| parent | d71ad7fcb80503e5bd2dec76fa1ad7f030e72995 (diff) | |
| download | gdb-dd5d5494f4b899b0411fc62c2041ead9cc5e6a53.zip gdb-dd5d5494f4b899b0411fc62c2041ead9cc5e6a53.tar.gz gdb-dd5d5494f4b899b0411fc62c2041ead9cc5e6a53.tar.bz2 | |
Add space before the opening parenthesis in function descriptions.
gdb/doc
* python.texi (Xmethod API): Add space before the opening
parenthesis in function descriptions.
Diffstat (limited to 'gdb')
| -rw-r--r-- | gdb/doc/ChangeLog | 5 | ||||
| -rw-r--r-- | gdb/doc/python.texi | 12 |
2 files changed, 11 insertions, 6 deletions
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog index 2ba7d39..9035c37 100644 --- a/gdb/doc/ChangeLog +++ b/gdb/doc/ChangeLog @@ -1,3 +1,8 @@ +2014-06-09 Siva Chandra Reddy <sivachandra@google.com> + + * python.texi (Xmethod API): Add space before the opening + parenthesis in function descriptions. + 2014-06-06 Doug Evans <xdje42@gmail.com> * guile.texi (Guile Configuration): Document guile-data-directory. diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi index 2f1b71f..4688783 100644 --- a/gdb/doc/python.texi +++ b/gdb/doc/python.texi @@ -2270,7 +2270,7 @@ disabled. The class @code{XMethod} is a convenience class with same attributes as above along with the following constructor: -@defun XMethod.__init__(self, name) +@defun XMethod.__init__ (self, name) Constructs an enabled xmethod with name @var{name}. @end defun @end defvar @@ -2278,12 +2278,12 @@ Constructs an enabled xmethod with name @var{name}. @noindent The @code{XMethodMatcher} class has the following methods: -@defun XMethodMatcher.__init__(self, name) +@defun XMethodMatcher.__init__ (self, name) Constructs an enabled xmethod matcher with name @var{name}. The @code{methods} attribute is initialized to @code{None}. @end defun -@defun XMethodMatcher.match(self, class_type, method_name) +@defun XMethodMatcher.match (self, class_type, method_name) Derived classes should override this method. It should return a xmethod worker object (or a sequence of xmethod worker objects) matching the @var{class_type} and @var{method_name}. @@ -2298,7 +2298,7 @@ An xmethod worker should be an instance of a class derived from @code{XMethodWorker} defined in the module @code{gdb.xmethod}, or support the following interface: -@defun XMethodWorker.get_arg_types(self) +@defun XMethodWorker.get_arg_types (self) This method returns a sequence of @code{gdb.Type} objects corresponding to the arguments that the xmethod takes. It can return an empty sequence or @code{None} if the xmethod does not take any arguments. @@ -2306,7 +2306,7 @@ If the xmethod takes a single argument, then a single @code{gdb.Type} object corresponding to it can be returned. @end defun -@defun XMethodWorker.__call__(self, *args) +@defun XMethodWorker.__call__ (self, *args) This is the method which does the @emph{work} of the xmethod. The @var{args} arguments is the tuple of arguments to the xmethod. Each element in this tuple is a gdb.Value object. The first element is @@ -2317,7 +2317,7 @@ For @value{GDBN} to lookup xmethods, the xmethod matchers should be registered using the following function defined in the module @code{gdb.xmethod}: -@defun register_xmethod_matcher(locus, matcher, replace=False) +@defun register_xmethod_matcher (locus, matcher, replace=False) The @code{matcher} is registered with @code{locus}, replacing an existing matcher with the same name as @code{matcher} if @code{replace} is @code{True}. @code{locus} can be a |