[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 4/6] qapi/introspect: Supply missing member documentation
From: |
Markus Armbruster |
Subject: |
[PATCH 4/6] qapi/introspect: Supply missing member documentation |
Date: |
Thu, 8 Aug 2024 20:26:34 +0200 |
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
- [PATCH 0/6] qapi: Supply some of the missing member documentation, Markus Armbruster, 2024/08/08
- [PATCH 4/6] qapi/introspect: Supply missing member documentation,
Markus Armbruster <=
- [PATCH 2/6] qapi/common: Supply missing member documentation, Markus Armbruster, 2024/08/08
- [PATCH 3/6] qapi/crypto: Supply missing member documentation, Markus Armbruster, 2024/08/08
- [PATCH 5/6] qapi/pci: Supply missing member documentation, Markus Armbruster, 2024/08/08
- [PATCH 6/6] qapi/rocker: Supply missing member documentation, Markus Armbruster, 2024/08/08
- Re: [PATCH 0/6] qapi: Supply some of the missing member documentation, John Snow, 2024/08/08