]> git.ipfire.org Git - thirdparty/qemu.git/commitdiff
qapi: Fix bogus documentation of query-migrationthreads
authorMarkus Armbruster <armbru@redhat.com>
Fri, 22 Mar 2024 13:51:17 +0000 (14:51 +0100)
committerMarkus Armbruster <armbru@redhat.com>
Tue, 26 Mar 2024 05:36:08 +0000 (06:36 +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

index 744d05f3648bbbdc476e58adfeecf519d3d6dd2f..c865ab00c8aa45b0622e783fa2fe6ea9e79b374f 100644 (file)
 #
 # Returns information of migration threads
 #
-# data: migration thread name
-#
-# Returns: information about migration threads
+# Returns: @MigrationThreadInfo
 #
 # Since: 7.2
 ##