qapi/yank: Clean up documentaion of yank

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>
Message-ID: <20240205074709.3613229-11-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>

diff --git a/qapi/pragma.json b/qapi/pragma.json
index 0fa64742b538cf564c2b895d5c8f36d2f94498ea..544f138afa6c4e86520e38f38fb3cf2604726539 100644 (file)
--- 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 60eda20816c41c8c58022beed2bf54d2b7caaae7..bfc71a07a6bd7888524c5664677d4938515e5915 100644 (file)
--- 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