[PULL,03/20] qapi: Fix bogus documentation of query-migrationthreads

Commit Message

Markus Armbruster March 26, 2024, 7:34 a.m. UTC

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 <[e-mail]>
Fixes: 671326201dac (migration: Introduce interface query-migrationthreads)
Signed-off-by: Markus Armbruster <[e-mail]>
Message-ID: <[e-mail]>
Reviewed-by: Fabiano Rosas <[e-mail]>
Reviewed-by: Peter Xu <[e-mail]>
Reviewed-by: John Snow <[e-mail]>
---
 qapi/migration.json | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

Patch

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
 ##