[2/3] Update target_stop's documentation
Commit Message
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(-)
Comments
On 09/18/2014 10:59 AM, Gary Benson wrote:
> This commit updates target_stop's documentation to clarify that
> it is asynchronous.
> + before returning. If this is the behaviour you want please use
US spelling: "behavior".
LGTM.
Thanks,
Pedro Alves
Pedro Alves wrote:
> On 09/18/2014 10:59 AM, Gary Benson wrote:
> > This commit updates target_stop's documentation to clarify that
> > it is asynchronous.
>
> > + before returning. If this is the behaviour you want please use
>
> US spelling: "behavior".
>
> LGTM.
Ok, I have fixed this and pushed the first two patches of this series.
Thanks,
Gary
@@ -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);