Skip to content

Commit a6af544

Browse files
jnsnowMarkus Armbruster
authored andcommitted
docs: enable transmogrifier for QSD and QGA
This also creates the `qapi-qsd-index` and `qapi-qga-index` QMP indices. Signed-off-by: John Snow <[email protected]> Message-ID: <[email protected]> Acked-by: Markus Armbruster <[email protected]> Signed-off-by: Markus Armbruster <[email protected]>
1 parent d85f7ef commit a6af544

File tree

5 files changed

+17
-0
lines changed

5 files changed

+17
-0
lines changed

docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,9 @@
164164
# Due to a limitation in Sphinx, we need to know which indices to
165165
# generate in advance. Adding a namespace here allows that generation.
166166
qapi_namespaces = {
167+
"QGA",
167168
"QMP",
169+
"QSD",
168170
}
169171

170172
# -- Options for HTML output ----------------------------------------------

docs/interop/qemu-ga-ref.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ QEMU Guest Agent Protocol Reference
55
:depth: 3
66

77
.. qapi-doc:: qga/qapi-schema.json
8+
:transmogrify:
9+
:namespace: QGA

docs/interop/qemu-storage-daemon-qmp-ref.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ QEMU Storage Daemon QMP Reference Manual
55
:depth: 3
66

77
.. qapi-doc:: storage-daemon/qapi/qapi-schema.json
8+
:transmogrify:
9+
:namespace: QSD

qga/qapi-schema.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33

44
##
55
# = QEMU guest agent protocol commands and structs
6+
#
7+
# For a concise listing of all commands, events, and types in the QEMU
8+
# guest agent, please consult the `qapi-qga-index`.
69
##
710

811
{ 'pragma': { 'doc-required': true } }

storage-daemon/qapi/qapi-schema.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@
1313
# the array type in the main schema, even if it is unused outside of the
1414
# storage daemon.
1515

16+
##
17+
# = QEMU storage daemon protocol commands and structs
18+
#
19+
# For a concise listing of all commands, events, and types in the QEMU
20+
# storage daemon, please consult the `qapi-qsd-index`.
21+
##
22+
23+
1624
{ 'include': '../../qapi/pragma.json' }
1725

1826
# Documentation generated with qapi-gen.py is in source order, with

0 commit comments

Comments
 (0)