| Message ID | 20240808182636.3657537-5-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | qapi: Supply some of the missing member documentation | expand |
On Thu, Aug 08, 2024 at 08:26:34PM GMT, Markus Armbruster wrote: > 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(-) Reviewed-by: Eric Blake <eblake@redhat.com>
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',
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(-)