From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org, "Daniel P . Berrangé" <berrange@redhat.com>
Subject: [PULL 10/18] qapi/yank: Clean up documentaion of yank
Date: Mon, 12 Feb 2024 10:14:28 +0100 [thread overview]
Message-ID: <20240212091436.688598-11-armbru@redhat.com> (raw)
In-Reply-To: <20240212091436.688598-1-armbru@redhat.com>
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>
---
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
next prev parent reply other threads:[~2024-02-12 9:15 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-12 9:14 [PULL 00/18] QAPI patches patches for 2024-02-12 Markus Armbruster
2024-02-12 9:14 ` [PULL 01/18] docs/devel/qapi-code-gen: Normalize version refs x.y.0 to just x.y Markus Armbruster
2024-02-12 9:14 ` [PULL 02/18] docs/devel/qapi-code-gen: Tweak doc comment whitespace Markus Armbruster
2024-02-12 9:14 ` [PULL 03/18] qapi/block-core: Fix BlockLatencyHistogramInfo doc markup Markus Armbruster
2024-02-12 9:14 ` [PULL 04/18] qapi: Indent tagged doc comment sections properly Markus Armbruster
2024-02-12 9:14 ` [PULL 05/18] sphinx/qapidoc: Drop code to generate doc for simple union tag Markus Armbruster
2024-02-12 9:14 ` [PULL 06/18] qapi: Require member documentation (with loophole) Markus Armbruster
2024-02-12 9:14 ` [PULL 07/18] qga/qapi-schema: Clean up documentation of guest-set-memory-blocks Markus Armbruster
2024-02-12 9:14 ` [PULL 08/18] qga/qapi-schema: Clean up documentation of guest-set-vcpus Markus Armbruster
2024-02-12 9:14 ` [PULL 09/18] qga/qapi-schema: Plug trivial documentation holes Markus Armbruster
2024-02-12 9:14 ` Markus Armbruster [this message]
2024-02-12 9:14 ` [PULL 11/18] qapi/dump: Clean up documentation of DumpGuestMemoryCapability Markus Armbruster
2024-02-12 9:14 ` [PULL 12/18] qapi: Plug trivial documentation holes around former simple unions Markus Armbruster
2024-02-12 9:14 ` [PULL 13/18] qapi: Improve documentation of file descriptor socket addresses Markus Armbruster
2024-02-12 9:14 ` [PULL 14/18] qapi: Move @String out of common.json to discourage reuse Markus Armbruster
2024-02-12 9:14 ` [PULL 15/18] qapi: Add missing union tag documentation Markus Armbruster
2024-02-12 9:14 ` [PULL 16/18] qapi/migration: Add missing tls-authz documentation Markus Armbruster
2024-02-12 9:14 ` [PULL 17/18] MAINTAINERS: Cover qapi/cxl.json Markus Armbruster
2024-02-12 9:14 ` [PULL 18/18] MAINTAINERS: Cover qapi/stats.json Markus Armbruster
2024-02-13 13:55 ` [PULL 00/18] QAPI patches patches for 2024-02-12 Peter Maydell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240212091436.688598-11-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).