Re: [PATCH v7 35/35] docs: mark '-mon' as deprecated in favour of -object

[Markus Armbruster <armbru@redhat.com>]

Daniel P. Berrangé <berrange@redhat.com> writes:

> The high level `-qmp` and `-monitor` options can remain as convenience
> wrappers, but the low level `-mon` is completed obsoleted by the new
> `-object` support with 'monitor-qmp' and 'monitor-hmp' types.
>
> Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> Tested-by: Peter Krempa <pkrempa@redhat.com>
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
>  docs/about/deprecated.rst               | 10 ++++++++++
>  docs/devel/writing-monitor-commands.rst |  4 ++--
>  docs/system/arm/xenpvh.rst              |  4 ++--
>  docs/system/i386/xen.rst                |  3 ++-
>  docs/system/i386/xenpvh.rst             |  4 ++--
>  qemu-options.hx                         | 16 ++++++++--------
>  system/vl.c                             |  2 ++
>  7 files changed, 28 insertions(+), 15 deletions(-)
>
> diff --git a/docs/about/deprecated.rst b/docs/about/deprecated.rst
> index 169c5dfe4f..023612748b 100644
> --- a/docs/about/deprecated.rst
> +++ b/docs/about/deprecated.rst
> @@ -61,6 +61,16 @@ The ``debug-threads`` option of the ``-name`` argument is now
>  ignored. Thread naming is unconditionally enabled for all platforms
>  where it is supported.
>  
> +``-mon`` option (since 11.1)
> +''''''''''''''''''''''''''''
> +
> +The ``-mon`` option was the generic mechanism for creating monitor
> +objects if the convenience ``-qmp`` or ``-monitor`` options were not
> +flexible enough. The monitor objects have been converted to QOM, so
> +``-mon mode=readline`` is replaced by ``-object monitor-hmp`` and
> +``-mon mode=control`` is replaced by ``-object monitor-qmp``. The
> +short convenience options are not deprecated, only ``-mon``.
> +
>  QEMU Machine Protocol (QMP) commands
>  ------------------------------------
>  
> diff --git a/docs/devel/writing-monitor-commands.rst b/docs/devel/writing-monitor-commands.rst
> index 930da5cd06..7ae7efe327 100644
> --- a/docs/devel/writing-monitor-commands.rst
> +++ b/docs/devel/writing-monitor-commands.rst
> @@ -52,8 +52,8 @@ shown here.
>  First, QEMU should be started like this::
>  
>   # qemu-system-TARGET [...] \
> -     -chardev socket,id=qmp,port=4444,host=localhost,server=on \
> -     -mon chardev=qmp,mode=control,pretty=on
> +     -chardev socket,id=chrqmp0,port=4444,host=localhost,server=on \
> +     -object monitor-qmp,chardev=chrqmp0,pretty=on,id=qmp0
>  
>  Then, in a different terminal::
>  
> diff --git a/docs/system/arm/xenpvh.rst b/docs/system/arm/xenpvh.rst
> index 430ac2c02e..511af63e3d 100644
> --- a/docs/system/arm/xenpvh.rst
> +++ b/docs/system/arm/xenpvh.rst
> @@ -27,9 +27,9 @@ Sample QEMU xenpvh commands for running and connecting with Xen:
>  
>      qemu-system-aarch64 -xen-domid 1 \
>        -chardev socket,id=libxl-cmd,path=qmp-libxl-1,server=on,wait=off \
> -      -mon chardev=libxl-cmd,mode=control \
> +      -object monitor-qmp,id=qmp0,chardev=libxl-cmd \
>        -chardev socket,id=libxenstat-cmd,path=qmp-libxenstat-1,server=on,wait=off \
> -      -mon chardev=libxenstat-cmd,mode=control \
> +      -object monitor-qmp,id=qmp1,chardev=libxenstat-cmd \
>        -xen-attach -name guest0 -vnc none -display none -nographic \
>        -machine xenpvh -m 1301 \
>        -chardev socket,id=chrtpm,path=tmp/vtpm2/swtpm-sock \
> diff --git a/docs/system/i386/xen.rst b/docs/system/i386/xen.rst
> index 46db5f34c1..6ff5cdb1e4 100644
> --- a/docs/system/i386/xen.rst
> +++ b/docs/system/i386/xen.rst
> @@ -79,7 +79,8 @@ of type ``xen-console`` to connect to it. For the Xen console equivalent of
>  the handy ``-serial mon:stdio`` option, for example:
>  
>  .. parsed-literal::
> -   -chardev stdio,mux=on,id=char0,signal=off -mon char0 \\
> +   -chardev stdio,mux=on,id=char0,signal=off \\
> +   -object monitor-hmp,chardev=char0,id=hmp0 \\
>     -device xen-console,chardev=char0
>  
>  The Xen network device is ``xen-net-device``, which becomes the default NIC
> diff --git a/docs/system/i386/xenpvh.rst b/docs/system/i386/xenpvh.rst
> index 354250f073..904778e3f5 100644
> --- a/docs/system/i386/xenpvh.rst
> +++ b/docs/system/i386/xenpvh.rst
> @@ -33,9 +33,9 @@ case you need to construct one manually:
>  
>      qemu-system-i386 -xen-domid 3 -no-shutdown        \
>        -chardev socket,id=libxl-cmd,path=/var/run/xen/qmp-libxl-3,server=on,wait=off \
> -      -mon chardev=libxl-cmd,mode=control             \
> +      -object monitor-qmp,id=qmp0,chardev=libxl-cmd   \
>        -chardev socket,id=libxenstat-cmd,path=/var/run/xen/qmp-libxenstat-3,server=on,wait=off \
> -      -mon chardev=libxenstat-cmd,mode=control        \
> +      -object monitor-qmp,id=qmp1,chardev=libxenstat-cmd \
>        -nodefaults                                     \
>        -no-user-config                                 \
>        -xen-attach -name g0                            \
> diff --git a/qemu-options.hx b/qemu-options.hx
> index fe76c18c81..acf68f8961 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -4154,7 +4154,7 @@ The general form of a character device option is:
>      ::
>  
>          -chardev stdio,mux=on,id=char0 \
> -        -mon chardev=char0,mode=readline \
> +        -object monitor-hmp,id=hmp0,chardev=char0 \
>          -serial chardev:char0 \
>          -serial chardev:char0
>  
> @@ -4166,7 +4166,7 @@ The general form of a character device option is:
>      ::
>  
>          -chardev stdio,mux=on,id=char0 \
> -        -mon chardev=char0,mode=readline \
> +        -object monitor-hmp,id=hmp0,chardev=char0 \
>          -parallel chardev:char0 \
>          -chardev tcp,...,mux=on,id=char1 \
>          -serial chardev:char1 \
> @@ -5004,12 +5004,13 @@ SRST
>  
>      enables the QMP monitor on localhost port 4444 with pretty-printing.
>  
> -    The use of ``-mon mode=readline`` is syntactic sugar
> +    The use of ``-mon mode=readline`` is deprecated syntactic sugar
> +    The use of ``-mon mode=readline`` is deprecated syntax sugar

Whoops!

Can fix this without a respin.

>      for the new ``-object monitor-hmp`` option, each use of which
>      creates an object with the ID ``compat_monitorNNN`` where ``NNN`` is
>      a counter starting from 0.
>  
> -    The use of ``-mon mode=control`` is syntactic sugar
> +    The use of ``-mon mode=control`` is deprecated syntactic sugar
>      for the new ``-object monitor-qmp`` option, each use of which
>      creates an object with the ID ``compat_monitorNNN`` where ``NNN`` is
>      a counter starting from 0.

[...]