mirror_qemu/docs/interop
Markus Armbruster 72e9e569d0 docs/interop/qmp-spec: How to force known good parser state
Section "QGA Synchronization" specifies that sending "a raw 0xFF
sentinel byte" makes the server "reset its state and discard all
pending data prior to the sentinel."  What actually happens there is a
lexical error, which will produce one or more error responses.
Moreover, it's not specific to QGA.

Create new section "Forcing the JSON parser into known-good state" to
document the technique properly.  Rewrite section "QGA
Synchronization" to document just the other direction, i.e. command
guest-sync-delimited.

Section "Protocol Specification" mentions "synchronization bytes
(documented below)".  Delete that.

While there, fix it not to claim '"Server" is QEMU itself', but
'"Server" is either QEMU or the QEMU Guest Agent'.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <20180823164025.12553-2-armbru@redhat.com>
2018-08-24 20:25:48 +02:00
..
bitmaps.rst bitmaps.md: Convert to rST; move it into 'interop' dir 2017-07-18 00:11:01 -04:00
firmware.json docs/interop: add "firmware.json" 2018-06-01 15:14:25 +02:00
live-block-operations.rst QAPI & interop: Clarify events emitted by 'block-job-cancel' 2017-11-27 14:59:35 +01:00
nbd.txt docs/interop: add nbd.txt 2018-06-21 09:23:59 -05:00
parallels.txt docs: create interop/ subdirectory 2017-06-15 11:18:39 +02:00
pr-helper.rst scsi: build qemu-pr-helper 2017-09-22 21:07:24 +02:00
prl-xml.txt docs/interop/prl-xml: description of Parallels Disk format 2018-01-22 14:02:33 +00:00
qcow2.txt docs: Grammar and spelling fixes 2018-07-13 10:16:04 +01:00
qed_spec.txt docs: create interop/ subdirectory 2017-06-15 11:18:39 +02:00
qemu-ga-ref.texi docs: create interop/ subdirectory 2017-06-15 11:18:39 +02:00
qemu-qmp-ref.texi docs: create interop/ subdirectory 2017-06-15 11:18:39 +02:00
qmp-intro.txt docs/interop/qmp: Improve OOB documentation 2018-07-03 23:09:31 +02:00
qmp-spec.txt docs/interop/qmp-spec: How to force known good parser state 2018-08-24 20:25:48 +02:00
vhost-user.txt docs: Grammar and spelling fixes 2018-07-13 10:16:04 +01:00
vnc-ledstate-Pseudo-encoding.txt docs: create interop/ subdirectory 2017-06-15 11:18:39 +02:00