qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org, Eric Blake <eblake@redhat.com>
Subject: [PULL 04/10] qapi/introspect: Supply missing member documentation
Date: Wed,  2 Oct 2024 09:43:58 +0200	[thread overview]
Message-ID: <20241002074404.1983368-5-armbru@redhat.com> (raw)
In-Reply-To: <20241002074404.1983368-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>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-ID: <20240911112545.2248881-5-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 625eac99df..7b0e12f42b 100644
--- a/qapi/pragma.json
+++ b/qapi/pragma.json
@@ -58,7 +58,6 @@
         'InputButton',
         'IscsiHeaderDigest',
         'IscsiTransport',
-        'JSONType',
         'KeyValueKind',
         'MemoryDeviceInfoKind',
         'NetClientDriver',
-- 
2.46.0



  parent reply	other threads:[~2024-10-02  7:44 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-02  7:43 [PULL 00/10] QAPI patches patches for 2024-10-02 Markus Armbruster
2024-10-02  7:43 ` [PULL 01/10] qapi/char: Supply missing member documentation Markus Armbruster
2024-10-02  7:43 ` [PULL 02/10] qapi/common: " Markus Armbruster
2024-10-02  7:43 ` [PULL 03/10] qapi/crypto: " Markus Armbruster
2024-10-02  7:43 ` Markus Armbruster [this message]
2024-10-02  7:43 ` [PULL 05/10] qapi/pci: " Markus Armbruster
2024-10-02  7:44 ` [PULL 06/10] qapi/rocker: " Markus Armbruster
2024-10-02  7:44 ` [PULL 07/10] qapi/cxl: " Markus Armbruster
2024-10-02  7:44 ` [PULL 08/10] qapi: Document QCryptodevBackendServiceType Markus Armbruster
2024-10-02  7:44 ` [PULL 09/10] qapi: Drop "with an explanation" from error descriptions Markus Armbruster
2024-10-02  7:44 ` [PULL 10/10] qapi/block-core: Drop drive-backup's "Any other error" documentation Markus Armbruster
2024-10-03 12:01 ` [PULL 00/10] QAPI patches patches for 2024-10-02 Peter Maydell

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=20241002074404.1983368-5-armbru@redhat.com \
    --to=armbru@redhat.com \
    --cc=eblake@redhat.com \
    --cc=peter.maydell@linaro.org \
    --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).