Clarify language for the '?' packet

Both QEMU and kgdb make the assumption that the '?' packet is only
sent during the initial setup of a gdbstub connection. Both use that
knowledge to reset breakpoints and ensure the gdbstub is in a
clean-state on a resumed connection. This can cause confusion for
others implementing clients that speak to gdbstub devices. To avoid
that make the language clearer that this is a start-up query packet
that you only expect to see once.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
gdb/doc/ChangeLog:

	* gdb.texinfo (Packets): Clarify language for ? packet.

Change-Id: Iae25d3110fe28b8d2467704962a6889e55224ca5

diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index d56cec23ff9d03c9941d6a55da8a12645333cd52..1d88c926346ca3d8f5f4c3769bff486e9944f958 100644 (file)
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,7 @@
+2020-12-23  Alex Bennée  <alex.bennee@linaro.org>
+
+       * gdb.texinfo (Packets): Clarify language for ? packet.
+
 2020-12-21  Joel Brobecker  <brobecker@adacore.com>
 
        * gdb.texinfo (Requirements): Add GMP to list of requirements.

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 617a3641382ea60a759c72e83e67f49047fcdcac..93e722881a3abf46ddd65be46bcbebd1328d3171 100644 (file)
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -39502,9 +39502,10 @@ The remote target both supports and has enabled extended mode.
 @item ?
 @cindex @samp{?} packet
 @anchor{? packet}
-Indicate the reason the target halted.  The reply is the same as for
-step and continue.  This packet has a special interpretation when the
-target is in non-stop mode; see @ref{Remote Non-Stop}.
+This is sent when connection is first established to query the reason
+the target halted.  The reply is the same as for step and continue.
+This packet has a special interpretation when the target is in
+non-stop mode; see @ref{Remote Non-Stop}.
 
 Reply:
 @xref{Stop Reply Packets}, for the reply specifications.