From patchwork Thu May 19 22:06:01 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tom Tromey X-Patchwork-Id: 12398 Received: (qmail 95276 invoked by alias); 19 May 2016 22:06:29 -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 94462 invoked by uid 89); 19 May 2016 22:06:29 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-0.8 required=5.0 tests=AWL, BAYES_00, FSL_HELO_HOME, RCVD_IN_DNSWL_NONE autolearn=no version=3.3.2 spammy=assisted, H*m:tromey, H*m:tom X-HELO: gproxy8-pub.mail.unifiedlayer.com Received: from gproxy8-pub.mail.unifiedlayer.com (HELO gproxy8-pub.mail.unifiedlayer.com) (67.222.33.93) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with SMTP; Thu, 19 May 2016 22:06:19 +0000 Received: (qmail 5794 invoked by uid 0); 19 May 2016 22:06:15 -0000 Received: from unknown (HELO cmgw2) (10.0.90.83) by gproxy8.mail.unifiedlayer.com with SMTP; 19 May 2016 22:06:15 -0000 Received: from box522.bluehost.com ([74.220.219.122]) by cmgw2 with id wN681s00X2f2jeq01N6B5k; Thu, 19 May 2016 16:06:13 -0600 X-Authority-Analysis: v=2.1 cv=QND7GG7L c=1 sm=1 tr=0 a=GsOEXm/OWkKvwdLVJsfwcA==:117 a=GsOEXm/OWkKvwdLVJsfwcA==:17 a=L9H7d07YOLsA:10 a=9cW_t1CCXrUA:10 a=s5jvgZ67dGcA:10 a=PnD2wP_eR3oA:10 a=_v2sUkyEFrwA:10 a=yrkiwgmsf1kA:10 a=zstS-IiYAAAA:8 a=8pMF1p-qSVCchbgfpl0A:9 a=4G6NA9xxw8l3yy4pmD5M:22 Received: from [71.215.116.141] (port=49672 helo=bapiya.Home) by box522.bluehost.com with esmtpsa (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.86_2) (envelope-from ) id 1b3W54-0005Pc-Cm; Thu, 19 May 2016 16:06:10 -0600 From: Tom Tromey To: gdb-patches@sourceware.org Cc: Tom Tromey Subject: [RFA 1/3] Rearrange Python breakpoint node in documentation Date: Thu, 19 May 2016 16:06:01 -0600 Message-Id: <1463695563-4130-2-git-send-email-tom@tromey.com> In-Reply-To: <1463695563-4130-1-git-send-email-tom@tromey.com> References: <1463695563-4130-1-git-send-email-tom@tromey.com> X-Identified-User: {36111:box522.bluehost.com:elynrobi:tromey.com} {sentby:smtp auth 71.215.116.141 authed with tom+tromey.com} I noticed that the Python breakpoint documentation was ordered a bit oddly. It documented the constructor; then the stop method; then the watchpoint constants (used for the constructor); then various other methods and attributes; then the other constants used by the constructor; and then finally some more methods and attributes. This patch rearranges the node a little to move the constants to just after the constructor and before the other methods and attributes. 2016-05-19 Tom Tromey * python.texi (Breakpoints In Python): Move table of types and table of watchpoint types earlier in node. --- gdb/doc/ChangeLog | 5 ++++ gdb/doc/python.texi | 84 ++++++++++++++++++++++++++--------------------------- 2 files changed, 47 insertions(+), 42 deletions(-) diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog index fe2e3be..3e9c35a 100644 --- a/gdb/doc/ChangeLog +++ b/gdb/doc/ChangeLog @@ -1,3 +1,8 @@ +2016-05-19 Tom Tromey + + * python.texi (Breakpoints In Python): Move table of types and + table of watchpoint types earlier in node. + 2016-05-17 Tom Tromey * gdb.texinfo (Supported Languages): Mention Rust. Update menu. diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi index ffbf89a..4847a14 100644 --- a/gdb/doc/python.texi +++ b/gdb/doc/python.texi @@ -4567,6 +4567,48 @@ the class of watchpoint to create, if @var{type} is is assumed to be a @code{gdb.WP_WRITE} class. @end defun +The available types are represented by constants defined in the @code{gdb} +module: + +@vtable @code +@vindex BP_BREAKPOINT +@item gdb.BP_BREAKPOINT +Normal code breakpoint. + +@vindex BP_WATCHPOINT +@item gdb.BP_WATCHPOINT +Watchpoint breakpoint. + +@vindex BP_HARDWARE_WATCHPOINT +@item gdb.BP_HARDWARE_WATCHPOINT +Hardware assisted watchpoint. + +@vindex BP_READ_WATCHPOINT +@item gdb.BP_READ_WATCHPOINT +Hardware assisted read watchpoint. + +@vindex BP_ACCESS_WATCHPOINT +@item gdb.BP_ACCESS_WATCHPOINT +Hardware assisted access watchpoint. +@end vtable + +The available watchpoint types represented by constants are defined in the +@code{gdb} module: + +@vtable @code +@vindex WP_READ +@item gdb.WP_READ +Read only watchpoint. + +@vindex WP_WRITE +@item gdb.WP_WRITE +Write only watchpoint. + +@vindex WP_ACCESS +@item gdb.WP_ACCESS +Read/Write watchpoint. +@end vtable + @defun Breakpoint.stop (self) The @code{gdb.Breakpoint} class can be sub-classed and, in particular, you may choose to implement the @code{stop} method. @@ -4601,23 +4643,6 @@ class MyBreakpoint (gdb.Breakpoint): @end smallexample @end defun -The available watchpoint types represented by constants are defined in the -@code{gdb} module: - -@vtable @code -@vindex WP_READ -@item gdb.WP_READ -Read only watchpoint. - -@vindex WP_WRITE -@item gdb.WP_WRITE -Write only watchpoint. - -@vindex WP_ACCESS -@item gdb.WP_ACCESS -Read/Write watchpoint. -@end vtable - @defun Breakpoint.is_valid () Return @code{True} if this @code{Breakpoint} object is valid, @code{False} otherwise. A @code{Breakpoint} object can become invalid @@ -4694,31 +4719,6 @@ function, will result in an error after the breakpoint has been hit writable. @end defvar -The available types are represented by constants defined in the @code{gdb} -module: - -@vtable @code -@vindex BP_BREAKPOINT -@item gdb.BP_BREAKPOINT -Normal code breakpoint. - -@vindex BP_WATCHPOINT -@item gdb.BP_WATCHPOINT -Watchpoint breakpoint. - -@vindex BP_HARDWARE_WATCHPOINT -@item gdb.BP_HARDWARE_WATCHPOINT -Hardware assisted watchpoint. - -@vindex BP_READ_WATCHPOINT -@item gdb.BP_READ_WATCHPOINT -Hardware assisted read watchpoint. - -@vindex BP_ACCESS_WATCHPOINT -@item gdb.BP_ACCESS_WATCHPOINT -Hardware assisted access watchpoint. -@end vtable - @defvar Breakpoint.hit_count This attribute holds the hit count for the breakpoint, an integer. This attribute is writable, but currently it can only be set to zero.