[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 03/20] qapi: Fix bogus documentation of query-migrationthreads
From: |
Markus Armbruster |
Subject: |
[PULL 03/20] qapi: Fix bogus documentation of query-migrationthreads |
Date: |
Tue, 26 Mar 2024 08:34:03 +0100 |
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>
Message-ID: <20240322135117.195489-4-armbru@redhat.com>
Reviewed-by: Fabiano Rosas <farosas@suse.de>
Reviewed-by: Peter Xu <peterx@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
---
qapi/migration.json | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/qapi/migration.json b/qapi/migration.json
index 744d05f364..c865ab00c8 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
- [PULL 00/20] QAPI patches patches for 2024-03-26, Markus Armbruster, 2024/03/26
- [PULL 01/20] qapi: Improve migration TLS documentation, Markus Armbruster, 2024/03/26
- [PULL 03/20] qapi: Fix bogus documentation of query-migrationthreads,
Markus Armbruster <=
- [PULL 02/20] qapi: Resync MigrationParameter and MigrateSetParameters, Markus Armbruster, 2024/03/26
- [PULL 11/20] qapi: Start sentences with a capital letter, end them with a period, Markus Armbruster, 2024/03/26
- [PULL 10/20] qapi: Fix abbreviation punctuation in doc comments, Markus Armbruster, 2024/03/26
- [PULL 05/20] qapi: Expand a few awkward abbreviations in documentation, Markus Armbruster, 2024/03/26
- [PULL 06/20] qapi: Tidy up block-latency-histogram-set documentation some more, Markus Armbruster, 2024/03/26
- [PULL 08/20] qapi: Fix argument markup in drive-mirror documentation, Markus Armbruster, 2024/03/26
- [PULL 09/20] qapi: Fix typo in request-ebpf documentation, Markus Armbruster, 2024/03/26
- [PULL 16/20] qapi: document InputMultiTouchType, Markus Armbruster, 2024/03/26
- [PULL 19/20] qapi/block-core: improve Qcow2OverlapCheckFlags documentation, Markus Armbruster, 2024/03/26
- [PULL 17/20] qapi: document leftover members in qapi/run-state.json, Markus Armbruster, 2024/03/26