Re: [PATCH 07/18] qapi: add cross-references to Machine core

[Markus Armbruster <armbru@redhat.com>]

John Snow <jsnow@redhat.com> writes:

> Signed-off-by: John Snow <jsnow@redhat.com>

[...]

> diff --git a/qapi/machine.json b/qapi/machine.json
> index 6aa8abe6cce..a18c23a273c 100644
> --- a/qapi/machine.json
> +++ b/qapi/machine.json

[...]

> @@ -1107,23 +1107,23 @@
>  ##
>  # @balloon:
>  #
> -# Request the balloon driver to change its balloon size.
> +# Request the `balloon` driver to change its `balloon` size.

The balloon driver is not the ballon command, and the ballon size isn't
the balloon command size, so no.

>  #
>  # @value: the target logical size of the VM in bytes.  We can deduce
> -#     the size of the balloon using this formula:
> +#     the size of the `balloon` using this formula:
>  #
>  #        logical_vm_size = vm_ram_size - balloon_size
>  #
>  #     From it we have: balloon_size = vm_ram_size - @value
>  #
>  # Errors:
> -#     - If the balloon driver is enabled but not functional because
> +#     - If the `balloon` driver is enabled but not functional because
>  #       the KVM kernel module cannot support it, KVMMissingCap
> -#     - If no balloon device is present, DeviceNotActive
> +#     - If no `balloon` device is present, DeviceNotActive
>  #
>  # .. note:: This command just issues a request to the guest.  When it
> -#    returns, the balloon size may not have changed.  A guest can
> -#    change the balloon size independent of this command.
> +#    returns, the `balloon` size may not have changed.  A guest can
> +#    change the `balloon` size independent of this command.
>  #
>  # Since: 0.14
>  #
> @@ -1142,7 +1142,7 @@
>  ##
>  # @BalloonInfo:
>  #
> -# Information about the guest balloon device.
> +# Information about the guest `balloon` device.
>  #
>  # @actual: the logical size of the VM in bytes.  Formula used:
>  #     logical_vm_size = vm_ram_size - balloon_size
> @@ -1154,12 +1154,12 @@
>  ##
>  # @query-balloon:
>  #
> -# Return information about the balloon device.
> +# Return information about the `balloon` device.
>  #
>  # Errors:
> -#     - If the balloon driver is enabled but not functional because
> +#     - If the `balloon` driver is enabled but not functional because
>  #       the KVM kernel module cannot support it, KVMMissingCap
> -#     - If no balloon device is present, DeviceNotActive
> +#     - If no `balloon` device is present, DeviceNotActive
>  #
>  # Since: 0.14
>  #
> @@ -1979,7 +1979,7 @@
>  #
>  # The result of a CPU model baseline.
>  #
> -# @model: the baselined CpuModelInfo.
> +# @model: the baselined `CpuModelInfo`.
>  #
>  # Since: 2.8
>  ##

No to all of these :)

[...]