qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: eblake@redhat.com, marcandre.lureau@redhat.com,
	pbonzini@redhat.com, berrange@redhat.com, mst@redhat.com,
	marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com
Subject: [PATCH 4/6] qapi/introspect: Supply missing member documentation
Date: Thu,  8 Aug 2024 20:26:34 +0200	[thread overview]
Message-ID: <20240808182636.3657537-5-armbru@redhat.com> (raw)
In-Reply-To: <20240808182636.3657537-1-armbru@redhat.com>

Since we neglect to document the members of JSONType, their
description in the QEMU QMP Reference manual is "Not documented".  Fix
that.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/introspect.json | 16 ++++++++++++++++
 qapi/pragma.json     |  1 -
 2 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/qapi/introspect.json b/qapi/introspect.json
index 14df049580..01bb242947 100644
--- a/qapi/introspect.json
+++ b/qapi/introspect.json
@@ -127,6 +127,22 @@
 # section 1, plus 'int' (split off 'number'), plus the obvious top
 # type 'value'.
 #
+# @string: JSON string
+#
+# @number: JSON number
+#
+# @int: JSON number that is an integer
+#
+# @boolean: literal ``false`` or ``true``
+#
+# @null: literal ``null``
+#
+# @object: JSON object
+#
+# @array: JSON array
+#
+# @value: any JSON value
+#
 # Since: 2.5
 ##
 { 'enum': 'JSONType',
diff --git a/qapi/pragma.json b/qapi/pragma.json
index fd6bdcaa6d..cc218f64b8 100644
--- a/qapi/pragma.json
+++ b/qapi/pragma.json
@@ -61,7 +61,6 @@
         'InputButton',
         'IscsiHeaderDigest',
         'IscsiTransport',
-        'JSONType',
         'KeyValueKind',
         'MemoryDeviceInfoKind',
         'NetClientDriver',
-- 
2.45.0



  parent reply	other threads:[~2024-08-08 18:27 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-08 18:26 [PATCH 0/6] qapi: Supply some of the missing member documentation Markus Armbruster
2024-08-08 18:26 ` [PATCH 1/6] qapi/char: Supply " Markus Armbruster
2024-08-08 20:48   ` John Snow
2024-08-09  4:51     ` Markus Armbruster
2024-08-09  8:44   ` Philippe Mathieu-Daudé
2024-08-09  9:11     ` Markus Armbruster
2024-08-12 18:10       ` John Snow
2024-08-08 18:26 ` [PATCH 2/6] qapi/common: " Markus Armbruster
2024-08-09  8:38   ` Philippe Mathieu-Daudé
2024-08-08 18:26 ` [PATCH 3/6] qapi/crypto: " Markus Armbruster
2024-08-09  8:39   ` Philippe Mathieu-Daudé
2024-08-08 18:26 ` Markus Armbruster [this message]
2024-08-09 12:27   ` [PATCH 4/6] qapi/introspect: " Eric Blake
2024-08-08 18:26 ` [PATCH 5/6] qapi/pci: " Markus Armbruster
2024-08-09  8:41   ` Philippe Mathieu-Daudé
2024-08-08 18:26 ` [PATCH 6/6] qapi/rocker: " Markus Armbruster
2024-08-09  8:41   ` Philippe Mathieu-Daudé
2024-08-08 20:51 ` [PATCH 0/6] qapi: Supply some of the " John Snow

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=20240808182636.3657537-5-armbru@redhat.com \
    --to=armbru@redhat.com \
    --cc=berrange@redhat.com \
    --cc=eblake@redhat.com \
    --cc=jiri@resnulli.us \
    --cc=jsnow@redhat.com \
    --cc=marcandre.lureau@redhat.com \
    --cc=marcel.apfelbaum@gmail.com \
    --cc=mst@redhat.com \
    --cc=pbonzini@redhat.com \
    --cc=qemu-devel@nongnu.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 NNTP newsgroup(s).