public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Reuben Thomas <rrt@sc3d.org>
To: gdb-patches@sourceware.org
Subject: [PATCH][gdb/doc] Fix to manual for description of remote protocol
Date: Tue, 21 Jul 2020 20:14:20 +0100	[thread overview]
Message-ID: <CAOnWdohdxheubNbuGuVVOGp5r0cAiVqsSR2LKSj8abzo-DcUvg@mail.gmail.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 516 bytes --]

See the thread starting at
https://sourceware.org/pipermail/gdb/2020-July/048808.html
and in particular the analysis I give in
https://sourceware.org/pipermail/gdb/2020-July/048817.html

The manual states in the section E.1 about the remote protocol that remote
stubs must implement the 's' command. This appears to be false. Further, it
does not mention the '?' command, which does appear to be required.

The attached patch against git master at the time of writing fixes these
two nits.

-- 
https://rrt.sc3d.org

[-- Attachment #2: 0001-Correct-an-error-in-the-remote-protocol-specificatio.patch --]
[-- Type: text/x-patch, Size: 2242 bytes --]

From 58199f8537dbac8887d91ed427c1f21e28f6894e Mon Sep 17 00:00:00 2001
From: Reuben Thomas <rrt@sc3d.org>
Date: Tue, 21 Jul 2020 20:00:31 +0100
Subject: [PATCH] Correct an error in the remote protocol specification

The list of commands that a stub must implement was wrong.

gdb/ChangeLog:

2020-07-21  Reuben Thomas  <rrt@sc3d.org>

	* doc/gdb.texinfo: Correct the description of which remote
	protocol commands are mandatory for a stub to implement.
---
 gdb/ChangeLog       |  5 +++++
 gdb/doc/gdb.texinfo | 13 +++++++------
 2 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index fad4608002..f2f9302078 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,8 @@
+2020-07-21  Reuben Thomas  <rrt@sc3d.org>
+
+	* doc/gdb.texinfo: Correct the description of which remote
+	protocol commands are mandatory for a stub to implement.
+
 2020-07-20  John Baldwin  <jhb@FreeBSD.org>
 
 	* fbsd-tdep.c (fbsd_skip_solib_resolver): New function.
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index a002084d5b..1e72c0ed32 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -39134,12 +39134,13 @@ For any @var{command} not supported by the stub, an empty response
 protocol.  A newer @value{GDBN} can tell if a packet is supported based
 on that response.
 
-At a minimum, a stub is required to support the @samp{g} and @samp{G}
-commands for register access, and the @samp{m} and @samp{M} commands
-for memory access.  Stubs that only control single-threaded targets
-can implement run control with the @samp{c} (continue), and @samp{s}
-(step) commands.  Stubs that support multi-threading targets should
-support the @samp{vCont} command.  All other commands are optional.
+At a minimum, a stub is required to support the @samp{?} command to tell
+@value{GDBN} the reason for halting, @samp{g} and @samp{G} commands for
+register access, and the @samp{m} and @samp{M} commands for memory
+access.  Stubs that only control single-threaded targets can implement
+run control with the @samp{c} (continue) command.  Stubs that support
+multi-threading targets should support the @samp{vCont} command.  All
+other commands are optional.
 
 @node Packets
 @section Packets
-- 
2.17.1


             reply	other threads:[~2020-07-21 19:14 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-21 19:14 Reuben Thomas [this message]
2020-07-22 13:56 ` Pedro Alves
2020-07-22 13:58   ` Reuben Thomas
2020-07-22 15:17     ` Pedro Alves

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=CAOnWdohdxheubNbuGuVVOGp5r0cAiVqsSR2LKSj8abzo-DcUvg@mail.gmail.com \
    --to=rrt@sc3d.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).