espressif/binutils-gdb
1
0
Fork 0
mirror of https://github.com/espressif/binutils-gdb.git synced 2025-06-22 02:50:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add space before the opening parenthesis in function descriptions.

Browse Source 
gdb/doc
	* python.texi (Xmethod API): Add space before the opening
	parenthesis in function descriptions.
This commit is contained in:
Siva Chandra
2014-06-09 06:47:22 -07:00
parent d71ad7fcb8
commit dd5d5494f4
2 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
gdb/doc/ChangeLog
View File

@ -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> 2014-06-06 Doug Evans <xdje42@gmail.com>
* guile.texi (Guile Configuration): Document guile-data-directory. * guile.texi (Guile Configuration): Document guile-data-directory.

12
gdb/doc/python.texi
View File

@ -2270,7 +2270,7 @@ disabled.
The class @code{XMethod} is a convenience class with same The class @code{XMethod} is a convenience class with same
attributes as above along with the following constructor: 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}. Constructs an enabled xmethod with name @var{name}.
@end defun @end defun
@end defvar @end defvar
@ -2278,12 +2278,12 @@ Constructs an enabled xmethod with name @var{name}.
@noindent @noindent
The @code{XMethodMatcher} class has the following methods: 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 Constructs an enabled xmethod matcher with name @var{name}. The
@code{methods} attribute is initialized to @code{None}. @code{methods} attribute is initialized to @code{None}.
@end defun @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 Derived classes should override this method. It should return a
xmethod worker object (or a sequence of xmethod worker xmethod worker object (or a sequence of xmethod worker
objects) matching the @var{class_type} and @var{method_name}. 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}, @code{XMethodWorker} defined in the module @code{gdb.xmethod},
or support the following interface: 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 This method returns a sequence of @code{gdb.Type} objects corresponding
to the arguments that the xmethod takes. It can return an empty to the arguments that the xmethod takes. It can return an empty
sequence or @code{None} if the xmethod does not take any arguments. 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. @code{gdb.Type} object corresponding to it can be returned.
@end defun @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 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 @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 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 should be registered using the following function defined in the module
@code{gdb.xmethod}: @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 The @code{matcher} is registered with @code{locus}, replacing an
existing matcher with the same name as @code{matcher} if existing matcher with the same name as @code{matcher} if
@code{replace} is @code{True}. @code{locus} can be a @code{replace} is @code{True}. @code{locus} can be a