aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Marchi <simon.marchi@ericsson.com>2014-10-20 13:29:36 -0400
committerSimon Marchi <simon.marchi@ericsson.com>2014-10-20 13:29:36 -0400
commitfab3a15dfb4255e9d5a79536518ccdbed4e66e23 (patch)
treed36b7a6fff5cb0567b37a519bd54a3f4d616642c
parent092f880b8e4cacee96e85a885c206e8879e86fec (diff)
downloadgdb-fab3a15dfb4255e9d5a79536518ccdbed4e66e23.zip
gdb-fab3a15dfb4255e9d5a79536518ccdbed4e66e23.tar.gz
gdb-fab3a15dfb4255e9d5a79536518ccdbed4e66e23.tar.bz2
Small fixes to the Python API doc
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".
-rw-r--r--gdb/doc/ChangeLog6
-rw-r--r--gdb/doc/python.texi5
2 files changed, 9 insertions, 2 deletions
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 474c1af..f1b2329 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,9 @@
+2014-10-20 Simon Marchi <simon.marchi@ericsson.com>
+
+ * python.texi (Breakpoints In Python): Add parenthesis after
+ Breakpoint.delete. Clarify Breakpoint.enabled description so
+ that it contains "disable".
+
2014-10-17 Doug Evans <dje@google.com>
* python.texi (Events In Python): Document clear_objfiles event.
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 43663d8..f1fd841 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -4265,7 +4265,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.
@@ -4273,7 +4273,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. This attribute is writable. You can use it to enable
+or disable the breakpoint.
@end defvar
@defvar Breakpoint.silent