John Snow <js...@redhat.com> writes:

> This also creates the qapi-qmp-index.html index and cross-reference
> target.
>
> Signed-off-by: John Snow <js...@redhat.com>
> ---
>  docs/conf.py                  | 4 +++-
>  docs/interop/qemu-qmp-ref.rst | 1 +
>  qapi/qapi-schema.json         | 2 +-
>  3 files changed, 5 insertions(+), 2 deletions(-)
>
> diff --git a/docs/conf.py b/docs/conf.py
> index 175491148c3..9a86e84a804 100644
> --- a/docs/conf.py
> +++ b/docs/conf.py
> @@ -163,7 +163,9 @@
>  
>  # Due to a limitation in Sphinx, we need to know which indices to
>  # generate in advance. Adding a namespace here allows that generation.
> -qapi_namespaces = set()
> +qapi_namespaces = {
> +    "QMP",
> +}
>  
>  # -- Options for HTML output ----------------------------------------------
>  
> diff --git a/docs/interop/qemu-qmp-ref.rst b/docs/interop/qemu-qmp-ref.rst
> index e95eeac45e2..ef8792b53f5 100644
> --- a/docs/interop/qemu-qmp-ref.rst
> +++ b/docs/interop/qemu-qmp-ref.rst
> @@ -8,3 +8,4 @@ QEMU QMP Reference Manual
>  
>  .. qapi-doc:: qapi/qapi-schema.json
>     :transmogrify:
> +   :namespace: QMP
> diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json
> index 4475e81cc3e..c41c01eb2ab 100644
> --- a/qapi/qapi-schema.json
> +++ b/qapi/qapi-schema.json
> @@ -5,7 +5,7 @@
>  #
>  # This document describes all commands currently supported by QMP.
>  #
> -# For locating a particular item, please see the `qapi-index`.
> +# For locating a particular item, please see the `qapi-qmp-index`.

Output changes from "see the QAPI Index" to "see the QMP Index", which
is an improvement.

I think I'd rather spell it "QMP index", though.  "Index" comes from
PATCH 08.  Not worth delaying the series. for that.

>  #
>  # Most of the time their usage is exactly the same as in the user
>  # Monitor, this means that any other document which also describe


Reply via email to