* breakpoint.c (insert_bp_location): Document return value.

	(insert_breakpoint_locations): Fix documentation.
	(remove_breakpoints): Add documentation.

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index e86cf187f464585fff4cf9e45721de4d90101b73..175f36389c8bcb0cf650a991080e6c226fa75904 100644 (file)
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,9 @@
+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.
+
 2011-07-31  Thiago Jung Bauermann  <bauerman@br.ibm.com>
 
        * breakpoint.c (insert_bp_location): Remove disabled_breaks

diff --git a/gdb/breakpoint.c b/gdb/breakpoint.c
index edfa661125be76d118b46da57d1f601160b7a2af..8fe16e6b4c0da726ae3c478491865b73529aaa6b 100644 (file)
--- 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)
 {