This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
[PATCH] Small fixes to the Python API doc
- From: Simon Marchi <simon dot marchi at ericsson dot com>
- To: <gdb-patches at sourceware dot org>
- Cc: Simon Marchi <simon dot marchi at ericsson dot com>
- Date: Thu, 16 Oct 2014 14:06:36 -0400
- Subject: [PATCH] Small fixes to the Python API doc
- Authentication-results: sourceware.org; auth=none
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