| Message ID | 20240808182636.3657537-7-armbru@redhat.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | qapi: Supply some of the missing member documentation | expand |
On 8/8/24 20:26, Markus Armbruster wrote: > 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(-) Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
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
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(-)