This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
[obvious] Improve documentation of some breakpoint functions
- From: Thiago Jung Bauermann <bauerman at br dot ibm dot com>
- To: gdb-patches ml <gdb-patches at sourceware dot org>
- Date: Sun, 31 Jul 2011 17:38:40 -0300
- Subject: [obvious] Improve documentation of some breakpoint functions
Hi,
The documentation for insert_bp_location didn't mention what the
function returns. Also, insert_breakpoint_locations had documentation
which was actually intended for insert_breakpoints just above it. And
besides, it was outdated.
Committed the following.
--
[]'s
Thiago Jung Bauermann
IBM Linux Technology Center
2011-07-31 Thiago Jung Bauermann <bauerman@br.ibm.com>
* breakpoint.c (insert_bp_location): Document return value.
(insert_breakpoint_locations): Fix documentation.
(remove_breakpoints): Add documentation.
diff --git a/gdb/breakpoint.c b/gdb/breakpoint.c
index edfa661..8fe16e6 100644
--- a/gdb/breakpoint.c
+++ b/gdb/breakpoint.c
@@ -1574,6 +1574,8 @@ should_be_inserted (struct bp_location *bl)
/* Insert a low-level "breakpoint" of some type. BL is the breakpoint
location. Any error messages are printed to TMP_ERROR_STREAM; and
HW_BREAKPOINT_ERROR is used to report problems.
+ Returns 0 for success, 1 if the bp_location type is not supported or
+ -1 for failure.
NOTE drow/2003-09-09: This routine could be broken down to an
object-style method for each breakpoint or catchpoint type. */
@@ -1897,10 +1899,7 @@ insert_breakpoints (void)
insert_breakpoint_locations ();
}
-/* insert_breakpoints is used when starting or continuing the program.
- remove_breakpoints is used when the program stops.
- Both return zero if successful,
- or an `errno' value if could not write the inferior. */
+/* Used when starting or continuing the program. */
static void
insert_breakpoint_locations (void)
@@ -2001,6 +2000,10 @@ You may have requested too many hardware breakpoints/watchpoints.\n");
do_cleanups (cleanups);
}
+/* Used when the program stops.
+ Returns zero if successful, or non-zero if there was a problem
+ removing a breakpoint location. */
+
int
remove_breakpoints (void)
{