[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH 13/13] qmp: document strict parsing
From: |
Luiz Capitulino |
Subject: |
[Qemu-devel] [PATCH 13/13] qmp: document strict parsing |
Date: |
Tue, 27 Mar 2012 09:20:51 -0300 |
From: Paolo Bonzini <address@hidden>
Signed-off-by: Paolo Bonzini <address@hidden>
Signed-off-by: Luiz Capitulino <address@hidden>
---
QMP/qmp-spec.txt | 20 +++++++++++++++++---
1 file changed, 17 insertions(+), 3 deletions(-)
diff --git a/QMP/qmp-spec.txt b/QMP/qmp-spec.txt
index 9d30a8c..1ba916c 100644
--- a/QMP/qmp-spec.txt
+++ b/QMP/qmp-spec.txt
@@ -209,13 +209,27 @@ incompatible way are disabled by default and will be
advertised by the
capabilities array (section '2.2 Server Greeting'). Thus, Clients can check
that array and enable the capabilities they support.
-Additionally, Clients must not assume any particular:
-
-- Size of json-objects or length of json-arrays
+The QMP Server performs a type check on the arguments to a command. It
+generates an error if a value does not have the expected type for its
+key, or if it does not understand a key that the Client included. The
+strictness of the Server catches wrong assumptions of Clients about
+the Server's schema. Clients can assume that, when such validation
+errors occur, they will be reported before the command generated any
+side effect.
+
+However, Clients must not assume any particular:
+
+- Length of json-arrays
+- Size of json-objects; in particular, future versions of QEMU may add
+ new keys and Clients should be able to ignore them.
- Order of json-object members or json-array elements
- Amount of errors generated by a command, that is, new errors can be added
to any existing command in newer versions of the Server
+Of course, the Server does guarantee to send valid JSON. But apart from
+this, a Client should be "conservative in what they send, and liberal in
+what they accept".
+
6. Downstream extension of QMP
------------------------------
--
1.7.9.2.384.g4a92a
- [Qemu-devel] [PATCH 01/13] qapi: fix double free in qmp_output_visitor_cleanup(), (continued)
- [Qemu-devel] [PATCH 01/13] qapi: fix double free in qmp_output_visitor_cleanup(), Luiz Capitulino, 2012/03/27
- [Qemu-devel] [PATCH 03/13] qapi: add a test case for type errors, Luiz Capitulino, 2012/03/27
- [Qemu-devel] [PATCH 05/13] qapi: fix memory leak on error, Luiz Capitulino, 2012/03/27
- [Qemu-devel] [PATCH 06/13] qapi: shortcut visits on errors, Luiz Capitulino, 2012/03/27
- [Qemu-devel] [PATCH 08/13] qapi: untangle next_list, Luiz Capitulino, 2012/03/27
- [Qemu-devel] [PATCH 04/13] qapi: fail hard on stack imbalance, Luiz Capitulino, 2012/03/27
- [Qemu-devel] [PATCH 07/13] qapi: allow freeing partially-allocated objects, Luiz Capitulino, 2012/03/27
- [Qemu-devel] [PATCH 12/13] qmp: parse commands in strict mode, Luiz Capitulino, 2012/03/27
- [Qemu-devel] [PATCH 09/13] qapi: place outermost object on qiv stack, Luiz Capitulino, 2012/03/27
- [Qemu-devel] [PATCH 11/13] qmp: add and use q type specifier, Luiz Capitulino, 2012/03/27
- [Qemu-devel] [PATCH 13/13] qmp: document strict parsing,
Luiz Capitulino <=
- [Qemu-devel] [PATCH 10/13] qapi: add strict mode to input visitor, Luiz Capitulino, 2012/03/27
- Re: [Qemu-devel] [PULL 00/13]: QMP queue, Anthony Liguori, 2012/03/30