From: Simon Marchi <simon.marchi@polymtl.ca>
Date: Thu, 29 Oct 2020 22:11:14 +0000 (-0400)
Subject: gdb: fix documentation of gdbarch_displaced_step_hw_singlestep
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=58103c3313048575eb44197f0afef951354a65e8;p=binutils-gdb.git

gdb: fix documentation of gdbarch_displaced_step_hw_singlestep

The last commit missed updating the doc of
gdbarch_displaced_step_hw_singlestep to avoid mentioning the removed
parameter, this one fixes it.

gdb/ChangeLog:

	* gdbarch.sh (displaced_step_hw_singlestep): Adjust
	documentation.
	* gdbarch.h: Re-generate.

Change-Id: I33675d9a6c253443eee707e8285d16615ce20aaa
---

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 7dfea4e9058..8be91cd5e29 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,9 @@
+2020-10-29  Simon Marchi  <simon.marchi@polymtl.ca>
+
+	* gdbarch.sh (displaced_step_hw_singlestep): Adjust
+	documentation.
+	* gdbarch.h: Re-generate.
+
 2020-10-29  Simon Marchi  <simon.marchi@polymtl.ca>
 
 	* gdbarch.sh (displaced_step_hw_singlestep): Remove closure
diff --git a/gdb/gdbarch.h b/gdb/gdbarch.h
index 8b1507b4ea8..10f36edd4cc 100644
--- a/gdb/gdbarch.h
+++ b/gdb/gdbarch.h
@@ -1034,15 +1034,14 @@ typedef displaced_step_closure_up (gdbarch_displaced_step_copy_insn_ftype) (stru
 extern displaced_step_closure_up gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
 extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
 
-/* Return true if GDB should use hardware single-stepping to execute
-   the displaced instruction identified by CLOSURE.  If false,
-   GDB will simply restart execution at the displaced instruction
-   location, and it is up to the target to ensure GDB will receive
-   control again (e.g. by placing a software breakpoint instruction
-   into the displaced instruction buffer).
+/* Return true if GDB should use hardware single-stepping to execute a displaced
+   step instruction.  If false, GDB will simply restart execution at the
+   displaced instruction location, and it is up to the target to ensure GDB will
+   receive control again (e.g. by placing a software breakpoint instruction into
+   the displaced instruction buffer).
   
-   The default implementation returns false on all targets that
-   provide a gdbarch_software_single_step routine, and true otherwise. */
+   The default implementation returns false on all targets that provide a
+   gdbarch_software_single_step routine, and true otherwise. */
 
 typedef bool (gdbarch_displaced_step_hw_singlestep_ftype) (struct gdbarch *gdbarch);
 extern bool gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch);
diff --git a/gdb/gdbarch.sh b/gdb/gdbarch.sh
index bff29c536c9..14f807904af 100755
--- a/gdb/gdbarch.sh
+++ b/gdb/gdbarch.sh
@@ -785,15 +785,14 @@ V;ULONGEST;max_insn_length;;;0;0
 # that case.
 M;displaced_step_closure_up;displaced_step_copy_insn;CORE_ADDR from, CORE_ADDR to, struct regcache *regs;from, to, regs
 
-# Return true if GDB should use hardware single-stepping to execute
-# the displaced instruction identified by CLOSURE.  If false,
-# GDB will simply restart execution at the displaced instruction
-# location, and it is up to the target to ensure GDB will receive
-# control again (e.g. by placing a software breakpoint instruction
-# into the displaced instruction buffer).
-#
-# The default implementation returns false on all targets that
-# provide a gdbarch_software_single_step routine, and true otherwise.
+# Return true if GDB should use hardware single-stepping to execute a displaced
+# step instruction.  If false, GDB will simply restart execution at the
+# displaced instruction location, and it is up to the target to ensure GDB will
+# receive control again (e.g. by placing a software breakpoint instruction into
+# the displaced instruction buffer).
+#
+# The default implementation returns false on all targets that provide a
+# gdbarch_software_single_step routine, and true otherwise.
 m;bool;displaced_step_hw_singlestep;void;;;default_displaced_step_hw_singlestep;;0
 
 # Fix up the state resulting from successfully single-stepping a