Re: [PATCH 11/11] docs: enable transmogrifier for QSD and QGA

[Markus Armbruster <armbru@redhat.com>]

John Snow <jsnow@redhat.com> writes:

> This also creates the `qapi-qsd-index` and `qapi-qga-index` QMP indices.
>
> Signed-off-by: John Snow <jsnow@redhat.com>

[...]

> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> index 995594aaf43..35ec0e7db31 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -3,6 +3,9 @@
>  
>  ##
>  # = QEMU guest agent protocol commands and structs
> +#
> +# For a concise listing of all commands, events, and types in the QEMU
> +# guest agent, please consult the `qapi-qga-index`.
>  ##
>  
>  { 'pragma': { 'doc-required': true } }
> diff --git a/storage-daemon/qapi/qapi-schema.json b/storage-daemon/qapi/qapi-schema.json
> index f10c9494906..2a562ee32e5 100644
> --- a/storage-daemon/qapi/qapi-schema.json
> +++ b/storage-daemon/qapi/qapi-schema.json
> @@ -13,6 +13,14 @@
>  # the array type in the main schema, even if it is unused outside of the
>  # storage daemon.
>  
> +##
> +# = QEMU storage daemon protocol commands and structs
> +#
> +# For a concise listing of all commands, events, and types in the QEMU
> +# storage daemon, please consult the `qapi-qsd-index`.
> +##
> +
> +
>  { 'include': '../../qapi/pragma.json' }
>  
>  # Documentation generated with qapi-gen.py is in source order, with

Compare qapi/qapi-schema.json:

   # = Introduction
   #
   # This document describes all commands currently supported by QMP.
   #
   # For locating a particular item, please see the `qapi-qmp-index`.
   #

Suggest to pick one phrasing and stick to it, unless there's a reason
for more than one.