Re: [PATCH 03/16] qapi: Fix misspelled references

[David Hildenbrand]

On 04.04.23 13:58, Markus Armbruster wrote:
> query-cpu-definitions returns a list of CpuDefinitionInfo, but
> documentation claims CpuDefInfo, which doesn't exist.
>
> query-migrate-capabilities returns a list of
> MigrationCapabilityStatus, but documentation claims
> MigrationCapabilitiesStatus, which doesn't exist.
>
> balloon and query-balloon can fail with KVMMissingCap, but
> documentation claims KvmMissingCap, which doesn't exist.
>
> Fix the documentation.
>
> Fixes: e4e31c6324af (qapi: add query-cpu-definitions command (v2))
> Fixes: bbf6da32b5bd (Add migration capabilities)
> Fixes: d72f326431e2 (qapi: Convert balloon)
> Fixes: 96637bcdf9e0 (qapi: Convert query-balloon)
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>   qapi/machine-target.json | 2 +-
>   qapi/machine.json        | 4 ++--
>   qapi/migration.json      | 2 +-
>   3 files changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/qapi/machine-target.json b/qapi/machine-target.json
> index 2e267fa458..b94fbdb65e 100644
> --- a/qapi/machine-target.json
> +++ b/qapi/machine-target.json
> @@ -331,7 +331,7 @@
>   #
>   # Return a list of supported virtual CPU definitions
>   #
> -# Returns: a list of CpuDefInfo
> +# Returns: a list of CpuDefinitionInfo
>   #
>   # Since: 1.2
>   ##
> diff --git a/qapi/machine.json b/qapi/machine.json
> index 604b686e59..8c3c58c763 100644
> --- a/qapi/machine.json
> +++ b/qapi/machine.json
> @@ -1029,7 +1029,7 @@
>   #
>   # Returns: - Nothing on success
>   #          - If the balloon driver is enabled but not functional because the 
> KVM
> -#            kernel module cannot support it, KvmMissingCap
> +#            kernel module cannot support it, KVMMissingCap
>   #          - If no balloon device is present, DeviceNotActive
>   #
>   # Notes: This command just issues a request to the guest.  When it returns,
> @@ -1067,7 +1067,7 @@
>   #
>   # Returns: - @BalloonInfo on success
>   #          - If the balloon driver is enabled but not functional because the 
> KVM
> -#            kernel module cannot support it, KvmMissingCap
> +#            kernel module cannot support it, KVMMissingCap
>   #          - If no balloon device is present, DeviceNotActive
>   #
>   # Since: 0.14
> diff --git a/qapi/migration.json b/qapi/migration.json
> index c84fa10e86..87c174dca2 100644
> --- a/qapi/migration.json
> +++ b/qapi/migration.json
> @@ -531,7 +531,7 @@
>   #
>   # Returns information about the current migration capabilities status
>   #
> -# Returns: @MigrationCapabilitiesStatus
> +# Returns: @MigrationCapabilityStatus
>   #
>   # Since: 1.2
>   #

Reviewed-by: David Hildenbrand <david@redhat.com>

--
Thanks,

David / dhildenb