Small improvements to the remote protocol manual
authorTom Tromey <tom@tromey.com>
Tue, 13 Sep 2016 22:50:34 +0000 (16:50 -0600)
committerTom Tromey <tom@tromey.com>
Wed, 28 Sep 2016 17:06:32 +0000 (11:06 -0600)
commit4435e1cc6214e6ef44bd90fcde8ae2de9d8be418
tree409184484189d0ae4e36c09ca0d685e63dee7de4
parent9eaff8613893f063400fdae95bc382ab33685e3b
Small improvements to the remote protocol manual

I was reading the gdb RSP manual recently and I found a number of
small problems in the documentation.  This patch attempts to improve
these areas.  Specfically:

* The term "memory breakpoint" is used only in this section of the
  manual, and there inconsistently.  I found this term confusing --
  initially I thought it might be a watchpoint.  This patch changes it
  to use the term "software breakpoint", which is used in the rest of
  the manual.

* The z0 packet didn't document how "kind" was written.  And, it had a
  stray link to the architecture-specific protocol details node.  This
  patch moves this link to a better spot.

* The z1 patch didn't document that it accepts cmd_list.

* I couldn't find any text saying what response is given to a command
  like vCont in non-stop mode.  The answer is that OK is sent, and
  then a stop reply is sent as a notification.  This patch adds a note
  about this.

* The "create" stop reply did not document that the "R" argument is
  ignored.

* The "W", "X", and "w" packets did not document how the "AA" part is
  formatted.

* The %Stop notification example said "%%Stop", but I think this is
  incorrect.

2016-09-28  Tom Tromey  <tom@tromey.com>

* gdb.texinfo (Packets) <z0>: Use "software breakpoint" rather
than "memory breakpoint".  Further document "kind".  Move
protocol-details link earlier.
<z1>: Document the cmd_list argument.  Fix typo.
<g>: Remove incorrect sentence.
(Stop Reply Packets): Document "OK" response to requests when in
non-stop mode.
<swbreak>: Use "software breakpoint" rather than "memory
breakpoint".
<create>: Document that "R" is ignored.
<W, X, w>: Document formatting of "AA".
(Notification Packets): Use "%Stop", not "%%Stop".
gdb/doc/ChangeLog
gdb/doc/gdb.texinfo