From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 826 invoked by alias); 16 Oct 2014 18:06:46 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 817 invoked by uid 89); 16 Oct 2014 18:06:45 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-2.4 required=5.0 tests=AWL,BAYES_00,RCVD_IN_DNSWL_LOW,SPF_PASS autolearn=ham version=3.3.2 X-HELO: usevmg21.ericsson.net Received: from usevmg21.ericsson.net (HELO usevmg21.ericsson.net) (198.24.6.65) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with (AES256-SHA encrypted) ESMTPS; Thu, 16 Oct 2014 18:06:44 +0000 Received: from EUSAAHC001.ericsson.se (Unknown_Domain [147.117.188.75]) by usevmg21.ericsson.net (Symantec Mail Security) with SMTP id 6C.26.25146.07FAF345; Thu, 16 Oct 2014 13:43:44 +0200 (CEST) Received: from simark-hp.mo.ca.am.ericsson.se (147.117.188.8) by smtps-am.internal.ericsson.com (147.117.188.75) with Microsoft SMTP Server (TLS) id 14.3.174.1; Thu, 16 Oct 2014 14:06:40 -0400 From: Simon Marchi To: CC: Simon Marchi Subject: [PATCH] Small fixes to the Python API doc Date: Thu, 16 Oct 2014 18:06:00 -0000 Message-ID: <1413482796-3090-1-git-send-email-simon.marchi@ericsson.com> MIME-Version: 1.0 Content-Type: text/plain X-IsSubscribed: yes X-SW-Source: 2014-10/txt/msg00431.txt.bz2 First: "Breakpoint.delete" is missing parenthesis. Second: Someone on IRC asked, how come there is no disable() method in the Breakpoint object. It turns out you have to do "bp.enabled = False". Since every normal person would probably search for "disable" in that page if their intent is to disable a python breakpoint, I thought it would be useful if the description contained "disable" so it would be easy to find. The result might seem a bit silly and redundant, so I am open to suggestions. gdb/doc/ChangeLog: * python.texi (Breakpoints In Python): Add parenthesis after Breakpoint.delete. Clarify Breakpoint.enabled description so that it contains "disable". --- gdb/doc/python.texi | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi index 81ec11b..bf12bf4 100644 --- a/gdb/doc/python.texi +++ b/gdb/doc/python.texi @@ -4250,7 +4250,7 @@ watchpoint scope, the watchpoint remains valid even if execution of the inferior leaves the scope of that watchpoint. @end defun -@defun Breakpoint.delete +@defun Breakpoint.delete () Permanently deletes the @value{GDBN} breakpoint. This also invalidates the Python @code{Breakpoint} object. Any further access to this object's attributes or methods will raise an error. @@ -4258,7 +4258,8 @@ to this object's attributes or methods will raise an error. @defvar Breakpoint.enabled This attribute is @code{True} if the breakpoint is enabled, and -@code{False} otherwise. This attribute is writable. +@code{False} otherwise. You can use it to enable or disable the breakpoint. +This attribute is writable. @end defvar @defvar Breakpoint.silent -- 2.1.0