| Message ID | 20250313044312.189276-12-jsnow@redhat.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | docs/qapi: enable new guest-agent and storage-daemon docs | expand |
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.
diff --git a/docs/conf.py b/docs/conf.py index 9a86e84a804..7b5712e122f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -164,7 +164,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 = { + "QGA", "QMP", + "QSD", } # -- Options for HTML output ---------------------------------------------- diff --git a/docs/interop/qemu-ga-ref.rst b/docs/interop/qemu-ga-ref.rst index 032d4924552..19b5c7a5498 100644 --- a/docs/interop/qemu-ga-ref.rst +++ b/docs/interop/qemu-ga-ref.rst @@ -5,3 +5,5 @@ QEMU Guest Agent Protocol Reference :depth: 3 .. qapi-doc:: qga/qapi-schema.json + :transmogrify: + :namespace: QGA diff --git a/docs/interop/qemu-storage-daemon-qmp-ref.rst b/docs/interop/qemu-storage-daemon-qmp-ref.rst index 9fed68152f5..d0228d63b8d 100644 --- a/docs/interop/qemu-storage-daemon-qmp-ref.rst +++ b/docs/interop/qemu-storage-daemon-qmp-ref.rst @@ -5,3 +5,5 @@ QEMU Storage Daemon QMP Reference Manual :depth: 3 .. qapi-doc:: storage-daemon/qapi/qapi-schema.json + :transmogrify: + :namespace: QSD 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
This also creates the `qapi-qsd-index` and `qapi-qga-index` QMP indices. Signed-off-by: John Snow <jsnow@redhat.com> --- docs/conf.py | 2 ++ docs/interop/qemu-ga-ref.rst | 2 ++ docs/interop/qemu-storage-daemon-qmp-ref.rst | 2 ++ qga/qapi-schema.json | 3 +++ storage-daemon/qapi/qapi-schema.json | 8 ++++++++ 5 files changed, 17 insertions(+)