Re: [PATCH] qapi: document leftover members in qapi/run-state.json

[Markus Armbruster <armbru@redhat.com>]

Paolo Bonzini <pbonzini@redhat.com> writes:

> Suggested-by: Markus Armbruster <armbru@redhat.com>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---
>  qapi/run-state.json | 26 +++++++++++++++++++++++++-
>  1 file changed, 25 insertions(+), 1 deletion(-)
>
> diff --git a/qapi/run-state.json b/qapi/run-state.json
> index 789fc34559a..cb4a2b43293 100644
> --- a/qapi/run-state.json
> +++ b/qapi/run-state.json
> @@ -377,9 +377,17 @@
>  ##
>  # @watchdog-set-action:
>  #
> -# Set watchdog action
> +# Set watchdog action.
> +#
> +# @action: @WatchdogAction action taken when watchdog timer expires.
>  #
>  # Since: 2.11
> +#
> +# Example:
> +#
> +#     -> { "execute": "watchdog-set-action",
> +#          "arguments": { "action": "inject-nmi" } }
> +#     <- { "return": {} }
>  ##
>  { 'command': 'watchdog-set-action', 'data' : {'action': 'WatchdogAction'} }
>  

Appreciate the example!

> @@ -505,6 +513,22 @@
>  #
>  # Hyper-V specific guest panic information (HV crash MSRs)
>  #
> +# @arg1: for Windows, STOP code for the guest crash.  For Linux,
> +#        an error code.
> +#
> +# @arg2: for Windows, first argument of the STOP.  For Linux, the
> +#        guest OS id, which has the kernel version in bits 16-47

Mind if I capitalize ID?

> +#        and 0x8100 in bits 48-63.
> +#
> +# @arg3: for Windows, second argument of the STOP.  For Linux, the
> +#        program counter of the guest.
> +#
> +# @arg4: for Windows, third argument of the STOP.  For Linux, the
> +#        RAX register (x86) or the stack pointer (aarch64) of the guest.
> +#
> +# @arg5: for Windows, fourth argument of the STOP.  For x86 Linux, the
> +#        stack pointer of the guest.
> +#
>  # Since: 2.9
>  ##
>  {'struct': 'GuestPanicInformationHyperV',

Reviewed-by: Markus Armbruster <armbru@redhat.com>