Message ID | 20240205074709.3613229-11-armbru@redhat.com |
---|---|
State | New |
Headers | show |
Series | qapi: Require member documentation (with loophole) | expand |
On Mon, Feb 05, 2024 at 08:47:04AM +0100, Markus Armbruster wrote: > The command's doc comment describes the argument, but it's not marked > up as such. Easy enough to fix. > > Signed-off-by: Markus Armbruster <armbru@redhat.com> > --- > qapi/pragma.json | 3 +-- > qapi/yank.json | 2 +- > 2 files changed, 2 insertions(+), 3 deletions(-) Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> With regards, Daniel
diff --git a/qapi/pragma.json b/qapi/pragma.json index 0fa64742b5..544f138afa 100644 --- a/qapi/pragma.json +++ b/qapi/pragma.json @@ -148,8 +148,7 @@ 'query-rocker', 'query-rocker-ports', 'query-stats-schemas', - 'watchdog-set-action', - 'yank' ], + 'watchdog-set-action' ], # Externally visible types whose member names may use uppercase 'member-name-exceptions': [ # visible in: 'ACPISlotType', # query-acpi-ospm-status diff --git a/qapi/yank.json b/qapi/yank.json index 60eda20816..bfc71a07a6 100644 --- a/qapi/yank.json +++ b/qapi/yank.json @@ -74,7 +74,7 @@ # Try to recover from hanging QEMU by yanking the specified instances. # See @YankInstance for more information. # -# Takes a list of @YankInstance as argument. +# @instances: the instances to be yanked # # Returns: # - Nothing on success
The command's doc comment describes the argument, but it's not marked up as such. Easy enough to fix. Signed-off-by: Markus Armbruster <armbru@redhat.com> --- qapi/pragma.json | 3 +-- qapi/yank.json | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-)