[PATCH 2/3] Update target_stop's documentation

[Gary Benson <gbenson@redhat.com>]

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

gdb/ChangeLog:

	* target.c (target_stop): Updated comment.
---
 gdb/ChangeLog |    4 ++++
 gdb/target.h  |    6 ++++--
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/gdb/target.h b/gdb/target.h
index 2ea7a2d..24fb757 100644
--- 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 behaviour you want please use
+   target_stop_and_wait.  */
 
 extern void target_stop (ptid_t ptid);
 
-- 
1.7.1