[binutils-gdb] Add comments to currently_stepping and target_resume

[Pedro Alves <palves at sourceware dot org>]

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=8b0615634896718c982d367a01ec61120084d3fb

commit 8b0615634896718c982d367a01ec61120084d3fb
Author: Pedro Alves <palves@redhat.com>
Date:   Fri Aug 7 17:23:59 2015 +0100

    Add comments to currently_stepping and target_resume
    
    Clarify that currently_stepping works at a higher level than
    target_resume.
    
    gdb/ChangeLog:
    2015-08-07  Pedro Alves  <palves@redhat.com>
    
    	* infrun.c (currently_stepping): Extend intro comment.
    	* target.h (target_resume): Extend intro comment.

Diff:
---
 gdb/ChangeLog | 5 +++++
 gdb/infrun.c  | 4 +++-
 gdb/target.h  | 4 ++--
 3 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index bd9f969..3e4cc04 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,5 +1,10 @@
 2015-08-07  Pedro Alves  <palves@redhat.com>
 
+	* infrun.c (currently_stepping): Extend intro comment.
+	* target.h (target_resume): Extend intro comment.
+
+2015-08-07  Pedro Alves  <palves@redhat.com>
+
 	* infrun.c (switch_back_to_stepped_thread): Use ecs->ptid instead
 	of inferior_ptid.  If the stepped thread vanished, return 0
 	instead of resuming here.  Use reset_ecs.  Print the prev_pc and
diff --git a/gdb/infrun.c b/gdb/infrun.c
index 455fc2d..32eeca8 100644
--- a/gdb/infrun.c
+++ b/gdb/infrun.c
@@ -5854,7 +5854,9 @@ switch_back_to_stepped_thread (struct execution_control_state *ecs)
   return 0;
 }
 
-/* Is thread TP in the middle of single-stepping?  */
+/* Is thread TP in the middle of (software or hardware)
+   single-stepping?  (Note the result of this function must never be
+   passed directly as target_resume's STEP parameter.)  */
 
 static int
 currently_stepping (struct thread_info *tp)
diff --git a/gdb/target.h b/gdb/target.h
index 462c0de..d616798 100644
--- a/gdb/target.h
+++ b/gdb/target.h
@@ -1292,8 +1292,8 @@ extern void target_detach (const char *, int);
 extern void target_disconnect (const char *, int);
 
 /* Resume execution of the target process PTID (or a group of
-   threads).  STEP says whether to single-step or to run free; SIGGNAL
-   is the signal to be given to the target, or GDB_SIGNAL_0 for no
+   threads).  STEP says whether to hardware single-step or to run free;
+   SIGGNAL is the signal to be given to the target, or GDB_SIGNAL_0 for no
    signal.  The caller may not pass GDB_SIGNAL_DEFAULT.  A specific
    PTID means `step/resume only this process id'.  A wildcard PTID
    (all threads, or all threads of process) means `step/resume