| Message ID | 20240322135117.195489-4-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | qapi/migration: Doc fixes | expand |
Markus Armbruster <armbru@redhat.com> writes: > 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> Reviewed-by: Fabiano Rosas <farosas@suse.de>
On Fri, Mar 22, 2024, 9:51 AM Markus Armbruster <armbru@redhat.com> wrote: > 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> > 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 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 > >
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 ##
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(-)