[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 6/6] qapi/rocker: Supply missing member documentation
From: |
Markus Armbruster |
Subject: |
[PATCH 6/6] qapi/rocker: Supply missing member documentation |
Date: |
Thu, 8 Aug 2024 20:26:36 +0200 |
Since we neglect to document the argument of query-rocker and
query-rocker-ports, their description in the QEMU QMP Reference manual
is "Not documented". Fix that.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/pragma.json | 4 +---
qapi/rocker.json | 4 ++++
2 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/qapi/pragma.json b/qapi/pragma.json
index 1570d6bcc6..ae9eaa2657 100644
--- a/qapi/pragma.json
+++ b/qapi/pragma.json
@@ -78,9 +78,7 @@
'X86CPURegister32',
'XDbgBlockGraph',
'YankInstanceType',
- 'blockdev-reopen',
- 'query-rocker',
- 'query-rocker-ports' ],
+ 'blockdev-reopen' ],
# Externally visible types whose member names may use uppercase
'member-name-exceptions': [ # visible in:
'ACPISlotType', # query-acpi-ospm-status
diff --git a/qapi/rocker.json b/qapi/rocker.json
index 6950ca9602..f1a87243fa 100644
--- a/qapi/rocker.json
+++ b/qapi/rocker.json
@@ -26,6 +26,8 @@
#
# Return rocker switch information.
#
+# @name: switch name
+#
# Returns: @Rocker information
#
# Since: 2.4
@@ -94,6 +96,8 @@
#
# Return rocker switch port information.
#
+# @name: port name
+#
# Returns: a list of @RockerPort information
#
# Since: 2.4
--
2.45.0
- Re: [PATCH 1/6] qapi/char: Supply missing member documentation, (continued)
[PATCH 4/6] qapi/introspect: Supply missing member documentation, Markus Armbruster, 2024/08/08
[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 <=
Re: [PATCH 0/6] qapi: Supply some of the missing member documentation, John Snow, 2024/08/08