public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: "Alex Bennée" <alex.bennee@linaro.org>
To: gdb-patches@sourceware.org
Cc: "Alex Bennée" <alex.bennee@linaro.org>
Subject: [PATCH v2] [gdb/doc]: clarify the language for the '?' packet
Date: Wed, 16 Dec 2020 18:23:32 +0000	[thread overview]
Message-ID: <20201216182332.15456-1-alex.bennee@linaro.org> (raw)

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/ChangeLog:

2020-12-16  Alex Bennée <alex.bennee@linaro.org>

	* doc/gdb.texinfo: add clarifying language for ? packet

---
v2
  - re-introduce line break
  - re-word first sentance
  - re-establish double spacing for sentence breaks
  - update gdb/ChangeLog
---
 gdb/ChangeLog       | 4 ++++
 gdb/doc/gdb.texinfo | 7 ++++---
 2 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 5dc879b0443..e4862061691 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,7 @@
+2020-12-16  Alex Bennée <alex.bennee@linaro.org>
+
+	* doc/gdb.texinfo: add clarifying language for ? packet
+
 2020-12-16  Tom Tromey  <tom@tromey.com>
 	    Tom Tromey  <tromey@redhat.com>
 	    Tom de Vries  <tdevries@suse.de>
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 5b6ac8549bc..70a8542cfb9 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -39493,9 +39493,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.
-- 
2.20.1


             reply	other threads:[~2020-12-16 18:23 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-16 18:23 Alex Bennée [this message]
2020-12-16 19:18 ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201216182332.15456-1-alex.bennee@linaro.org \
    --to=alex.bennee@linaro.org \
    --cc=gdb-patches@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).