diff options
author | Markus Armbruster <armbru@redhat.com> | 2024-03-22 14:51:17 +0100 |
---|---|---|
committer | Markus Armbruster <armbru@redhat.com> | 2024-03-26 06:36:08 +0100 |
commit | e6c60bf02d1c32b5e3e7dc761d1737aa8886ab79 (patch) | |
tree | a171f92e007c0bc68ff799b0ca523898fe3a2bae /qapi | |
parent | 8eb0a257c55d1b27dc8c40ce3c275307b898f575 (diff) |
qapi: Fix bogus documentation of query-migrationthreads
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>
Diffstat (limited to 'qapi')
-rw-r--r-- | qapi/migration.json | 4 |
1 files changed, 1 insertions, 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 ## |