[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 10/15] qapi/yank: Clean up documentaion of yank
From: |
Markus Armbruster |
Subject: |
[PATCH 10/15] qapi/yank: Clean up documentaion of yank |
Date: |
Mon, 5 Feb 2024 08:47:04 +0100 |
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(-)
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
--
2.43.0
- Re: [PATCH 02/15] docs/devel/qapi-code-gen: Tweak doc comment whitespace, (continued)
- [PATCH 04/15] qapi: Indent tagged doc comment sections properly, Markus Armbruster, 2024/02/05
- [PATCH 15/15] qapi: Add missing union tag documentation, Markus Armbruster, 2024/02/05
- [PATCH 11/15] qapi/dump: Clean up documentation of DumpGuestMemoryCapability, Markus Armbruster, 2024/02/05
- [PATCH 06/15] qapi: Require member documentation (with loophole), Markus Armbruster, 2024/02/05
- [PATCH 10/15] qapi/yank: Clean up documentaion of yank,
Markus Armbruster <=
- [PATCH 14/15] qapi: Move @String out of common.json to discourage reuse, Markus Armbruster, 2024/02/05
- [PATCH 12/15] qapi: Plug trivial documentation holes around former simple unions, Markus Armbruster, 2024/02/05
- [PATCH 07/15] qga/qapi-schema: Clean up documentation of guest-set-memory-blocks, Markus Armbruster, 2024/02/05
- [PATCH 05/15] sphinx/qapidoc: Drop code to generate doc for simple union tag, Markus Armbruster, 2024/02/05