[PATCH 1/2] docs: virsh: Modernize docs for qemu-monitor-command
Eric Blake
eblake at redhat.com
Fri Feb 7 15:33:53 UTC 2020
On 2/7/20 3:07 AM, Peter Krempa wrote:
> Mention that we actually by default use QMP and clarify the rest
> of the documentation.
>
> Signed-off-by: Peter Krempa <pkrempa at redhat.com>
> ---
> docs/manpages/virsh.rst | 19 ++++++++++++-------
> 1 file changed, 12 insertions(+), 7 deletions(-)
>
> diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst
> index 105b0d8f03..e10e5463a3 100644
> --- a/docs/manpages/virsh.rst
> +++ b/docs/manpages/virsh.rst
> @@ -7485,13 +7485,18 @@ qemu-monitor-command
> qemu-monitor-command domain { [--hmp] | [--pretty] } command...
>
> Send an arbitrary monitor command *command* to domain *domain* through the
> -QEMU monitor. The results of the command will be printed on stdout. If
> -*--hmp* is passed, the command is considered to be a human monitor command
> -and libvirt will automatically convert it into QMP if needed. In that case
> -the result will also be converted back from QMP. If *--pretty* is given,
> -and the monitor uses QMP, then the output will be pretty-printed. If more
> -than one argument is provided for *command*, they are concatenated with a
> -space in between before passing the single command to the monitor.
> +QEMU monitor. The results of the command will be printed on stdout.
> +
> +If more than one argument is provided for *command*, they are concatenated with
> +a space in between before passing the single command to the monitor.
> +
> +Note that libvirt uses the QMP to talk to qemu so *command* must be valid JSON
> +in QMP format to work properly.
Do we want to call any additional attention to the fact that libvirt
will NOT accept qemu's extensions beyond JSON (such as 'string' in place
of "string")?
Otherwise,
Reviewed-by: Eric Blake <eblake at redhat.com>
--
Eric Blake, Principal Software Engineer
Red Hat, Inc. +1-919-301-3226
Virtualization: qemu.org | libvirt.org
More information about the libvir-list
mailing list