From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peterx@redhat.com, farosas@suse.de, eblake@redhat.com,
berrange@redhat.com, John Snow <jsnow@redhat.com>
Subject: [PATCH 3/3] qapi: Fix bogus documentation of query-migrationthreads
Date: Fri, 22 Mar 2024 14:51:17 +0100 [thread overview]
Message-ID: <20240322135117.195489-4-armbru@redhat.com> (raw)
In-Reply-To: <20240322135117.195489-1-armbru@redhat.com>
The doc comment documents an argument that doesn't exist. Would
fail compilation if it was marked up correctly. Delete.
The Returns: section fails to refer to the data type, leaving the user
to guess. Fix that.
The command name violates QAPI naming rules: it should be
query-migration-threads. Too late to fix.
Reported-by: John Snow <jsnow@redhat.com>
Fixes: 671326201dac (migration: Introduce interface query-migrationthreads)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/migration.json | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/qapi/migration.json b/qapi/migration.json
index f6238b6980..e47ad7a63b 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -2419,9 +2419,7 @@
#
# Returns information of migration threads
#
-# data: migration thread name
-#
-# Returns: information about migration threads
+# Returns: @MigrationThreadInfo
#
# Since: 7.2
##
--
2.44.0
next prev parent reply other threads:[~2024-03-22 13:52 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-22 13:51 [PATCH 0/3] qapi/migration: Doc fixes Markus Armbruster
2024-03-22 13:51 ` [PATCH 1/3] qapi: Improve migration TLS documentation Markus Armbruster
2024-03-22 14:01 ` Fabiano Rosas
2024-03-22 14:12 ` Markus Armbruster
2024-03-22 13:51 ` [PATCH 2/3] qapi: Resync MigrationParameter and MigrateSetParameters Markus Armbruster
2024-03-22 14:10 ` Fabiano Rosas
2024-03-22 13:51 ` Markus Armbruster [this message]
2024-03-22 14:11 ` [PATCH 3/3] qapi: Fix bogus documentation of query-migrationthreads Fabiano Rosas
2024-03-22 15:25 ` John Snow
2024-03-22 15:06 ` [PATCH 0/3] qapi/migration: Doc fixes Peter Xu
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=20240322135117.195489-4-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=eblake@redhat.com \
--cc=farosas@suse.de \
--cc=jsnow@redhat.com \
--cc=peterx@redhat.com \
--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).