[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v3 1/3] docs: generate qemu-storage-daemon-qmp-ref(7) man pag
From: |
Kevin Wolf |
Subject: |
Re: [PATCH v3 1/3] docs: generate qemu-storage-daemon-qmp-ref(7) man page |
Date: |
Tue, 15 Dec 2020 17:11:06 +0100 |
Am 09.12.2020 um 11:38 hat Stefan Hajnoczi geschrieben:
> Although individual qemu-storage-daemon QMP commands are identical to
> QEMU QMP commands, qemu-storage-daemon only supports a subset of QEMU's
> QMP commands. Generate a manual page of just the commands supported by
> qemu-storage-daemon so that users know exactly what is available in
> qemu-storage-daemon.
>
> Add an h1 heading in storage-daemon/qapi/qapi-schema.json so that
> block-core.json is at the h2 heading level.
>
> Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
> ---
> docs/interop/index.rst | 1 +
> docs/interop/qemu-storage-daemon-qmp-ref.rst | 13 +++++++++++++
> storage-daemon/qapi/qapi-schema.json | 3 +++
> docs/interop/conf.py | 2 ++
> docs/meson.build | 1 +
> 5 files changed, 20 insertions(+)
> create mode 100644 docs/interop/qemu-storage-daemon-qmp-ref.rst
>
> diff --git a/docs/interop/index.rst b/docs/interop/index.rst
> index cd78d679d8..95d56495f6 100644
> --- a/docs/interop/index.rst
> +++ b/docs/interop/index.rst
> @@ -20,6 +20,7 @@ Contents:
> qemu-ga
> qemu-ga-ref
> qemu-qmp-ref
> + qemu-storage-daemon-qmp-ref
> vhost-user
> vhost-user-gpu
> vhost-vdpa
> diff --git a/docs/interop/qemu-storage-daemon-qmp-ref.rst
> b/docs/interop/qemu-storage-daemon-qmp-ref.rst
> new file mode 100644
> index 0000000000..caf9dad23a
> --- /dev/null
> +++ b/docs/interop/qemu-storage-daemon-qmp-ref.rst
> @@ -0,0 +1,13 @@
> +QEMU Storage Daemon QMP Reference Manual
> +========================================
> +
> +..
> + TODO: the old Texinfo manual used to note that this manual
> + is GPL-v2-or-later. We should make that reader-visible
> + both here and in our Sphinx manuals more generally.
> +
> +..
> + TODO: display the QEMU version, both here and in our Sphinx manuals
> + more generally.
> +
> +.. qapi-doc:: storage-daemon/qapi/qapi-schema.json
Did you intend to actually merge the TODO comments like this into master
or was this meant to be resolved before you send the series?
Kevin
[PATCH v3 2/3] docs: add qemu-storage-daemon(1) man page, Stefan Hajnoczi, 2020/12/09
[PATCH v3 3/3] MAINTAINERS: add Kevin Wolf as storage daemon maintainer, Stefan Hajnoczi, 2020/12/09