From patchwork Mon Jun 9 14:23:27 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Siva Chandra Reddy X-Patchwork-Id: 1377 Received: (qmail 23459 invoked by alias); 9 Jun 2014 14:23:33 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Delivered-To: mailing list gdb-patches@sourceware.org Received: (qmail 23448 invoked by uid 89); 9 Jun 2014 14:23:32 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-3.1 required=5.0 tests=AWL, BAYES_00, RCVD_IN_DNSWL_LOW, RP_MATCHES_RCVD, SPF_PASS autolearn=ham version=3.3.2 X-HELO: mail-wi0-f171.google.com Received: from mail-wi0-f171.google.com (HELO mail-wi0-f171.google.com) (209.85.212.171) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with (AES128-SHA encrypted) ESMTPS; Mon, 09 Jun 2014 14:23:31 +0000 Received: by mail-wi0-f171.google.com with SMTP id n15so1332698wiw.10 for ; Mon, 09 Jun 2014 07:23:28 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:date:message-id:subject:from:to :content-type; bh=6mOSrDLwQlHwk2kP0kQ99FaL8b5QFaSXnOSKhgmbOd0=; b=K7e/ASTIwUFl9QI1mqzPjNlzCRu3zibplXSDmo+AlYZ5vBn6yi8eaH/QcR+e20GRo1 XWqZwvmFESv1NS8ZeJgSUDZuc9zkBTg7oF3y1GL5U3uErv34+9oI3NOLHHJd3H9Wty/U DOIey/n+Bo7jKBoWE4E9nM8DodVyv7Jd0liSS6hrwZwbHU7m2mX19AEN2Y/RWZiVXdvQ zsSGI97XcUIirJ60387o1DGmBb7+kqlLkp55S8ThVEY5VYxQ57t6hIjPDCBH3oB6VMXK A5fZANk6GbTJPSf7Y3smGLdi4f9dLo5GkJ72yXE3wuB+JO0MfM48DqzyDU0iu0VdKCV/ 76Mw== X-Gm-Message-State: ALoCoQmioa+NR92PE++VuLXLk0z1DIY5HI3Pjycph6J96HaqW4Rmp+7w71p6K/M7V6xW9/xJ5iYb MIME-Version: 1.0 X-Received: by 10.194.22.100 with SMTP id c4mr4962695wjf.89.1402323808406; Mon, 09 Jun 2014 07:23:28 -0700 (PDT) Received: by 10.217.51.7 with HTTP; Mon, 9 Jun 2014 07:23:27 -0700 (PDT) Date: Mon, 9 Jun 2014 07:23:27 -0700 Message-ID: Subject: [pushed/obv] DOC: Add space before the opening parenthesis in function descriptions From: Siva Chandra To: gdb-patches X-IsSubscribed: yes doc/ 2014-06-09 Siva Chandra Reddy * python.texi (Xmethod API): Add space before the opening parenthesis in function descriptions. 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