[PATCH v3 2/3] docs/interop/qmp-spec: Update error description for parsing errors

Peter Maydell posted 3 patches 2 years, 9 months ago
Maintainers: Markus Armbruster <armbru@redhat.com>, Michael Roth <michael.roth@amd.com>, John Snow <jsnow@redhat.com>, Cleber Rosa <crosa@redhat.com>, Beraldo Leal <bleal@redhat.com>, Eric Blake <eblake@redhat.com>
[PATCH v3 2/3] docs/interop/qmp-spec: Update error description for parsing errors
Posted by Peter Maydell 2 years, 9 months ago
The description text for a parsing error has changed since the
spec doc was first written; update the example in the docs.

Suggested-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
 docs/interop/qmp-spec.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/interop/qmp-spec.rst b/docs/interop/qmp-spec.rst
index bfad570a160..2609b3ff9b2 100644
--- a/docs/interop/qmp-spec.rst
+++ b/docs/interop/qmp-spec.rst
@@ -307,7 +307,7 @@ This section provides some examples of real QMP usage, in all of them
   .. code-block:: QMP
 
     -> { "execute": }
-    <- { "error": { "class": "GenericError", "desc": "Invalid JSON syntax" } }
+    <- { "error": { "class": "GenericError", "desc": "JSON parse error, expecting value" } }
 
 .. admonition:: Example
 
-- 
2.34.1
Re: [PATCH v3 2/3] docs/interop/qmp-spec: Update error description for parsing errors
Posted by Markus Armbruster 2 years, 8 months ago
Peter Maydell <peter.maydell@linaro.org> writes:

> The description text for a parsing error has changed since the
> spec doc was first written; update the example in the docs.
>
> Suggested-by: Markus Armbruster <armbru@redhat.com>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

Reviewed-by: Markus Armbruster <armbru@redhat.com>
Re: [PATCH v3 2/3] docs/interop/qmp-spec: Update error description for parsing errors
Posted by Eric Blake 2 years, 9 months ago
On Mon, May 15, 2023 at 05:22:44PM +0100, Peter Maydell wrote:
> 
> The description text for a parsing error has changed since the
> spec doc was first written; update the example in the docs.
> 
> Suggested-by: Markus Armbruster <armbru@redhat.com>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
>  docs/interop/qmp-spec.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Reviewed-by: Eric Blake <eblake@redhat.com>

You mentioned elsewhere in the series about keeping my other R-b
because the changes were minor; I agree with that decision.

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org