Update target_stop's documentation

This commit updates target_stop's documentation to clarify that
it is asynchronous.

gdb/ChangeLog:

	* target.c (target_stop): Updated comment.

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 48e39df..35ecebc 100644 (file)
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,5 +1,9 @@
 2014-09-22  Gary Benson  <gbenson@redhat.com>
 
+       * target.c (target_stop): Updated comment.
+
+2014-09-22  Gary Benson  <gbenson@redhat.com>
+
        * target/target.h (target_stop_ptid): Renamed as...
        (target_stop_and_wait): New function.  Updated comment.
        All uses updated.

diff --git a/gdb/target.h b/gdb/target.h
index 2ea7a2d..a679228 100644 (file)
--- a/gdb/target.h
+++ b/gdb/target.h
@@ -1573,8 +1573,10 @@ extern int target_thread_alive (ptid_t ptid);
 extern void target_find_new_threads (void);
 
 /* Make target stop in a continuable fashion.  (For instance, under
-   Unix, this should act like SIGSTOP).  This function is normally
-   used by GUIs to implement a stop button.  */
+   Unix, this should act like SIGSTOP).  Note that this function is
+   asynchronous: it does not wait for the target to become stopped
+   before returning.  If this is the behavior you want please use
+   target_stop_and_wait.  */
 
 extern void target_stop (ptid_t ptid);