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.
This commit is contained in:
Gary Benson 2014-09-22 11:33:59 +01:00
parent 03f4463bfc
commit 9a6cf3683d
2 changed files with 8 additions and 2 deletions

View File

@ -1,3 +1,7 @@
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...

View File

@ -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);