summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Tromey <tom@tromey.com>2016-05-19 15:40:54 -0600
committerTom Tromey <tom@tromey.com>2016-07-13 13:20:58 -0600
commitcda75e7050781403875413a57c5700e67b1c6269 (patch)
tree1ce948761ae0d21e765d3c950ee220d6fe30d34e
parent6571a3815623d907b7a3f560e909edd8c76a9e1c (diff)
downloadbinutils-gdb-cda75e7050781403875413a57c5700e67b1c6269.tar.gz
Rearrange Python breakpoint node in documentation
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-07-13 Tom Tromey <tom@tromey.com> * python.texi (Breakpoints In Python): Move table of types and table of watchpoint types earlier in node.
-rw-r--r--gdb/doc/ChangeLog5
-rw-r--r--gdb/doc/python.texi84
2 files changed, 47 insertions, 42 deletions
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 385ca412d73..2e0c0bb6267 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,8 @@
+2016-07-13 Tom Tromey <tom@tromey.com>
+
+ * python.texi (Breakpoints In Python): Move table of types and
+ table of watchpoint types earlier in node.
+
2016-07-12 Tom Tromey <tom@tromey.com>
PR python/19293:
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index f218ad6089c..69134d4ac9f 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -4579,6 +4579,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.
@@ -4613,23 +4655,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
@@ -4706,31 +4731,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.