]> git.ipfire.org Git - thirdparty/qemu.git/commit
docs/qapi-domain: add qapi:namespace directive
authorJohn Snow <jsnow@redhat.com>
Thu, 13 Mar 2025 04:43:06 +0000 (00:43 -0400)
committerMarkus Armbruster <armbru@redhat.com>
Fri, 14 Mar 2025 06:31:57 +0000 (07:31 +0100)
commit7c7247b252dd8b3911b96451c0eaaebbc6ac0af0
tree0800a368d80a6ca2b3d003286147aa4f3042ac43
parent9ca404f0043d63043bfed3af8da3adedc062cb13
docs/qapi-domain: add qapi:namespace directive

Add a new directive that marks the beginning of a QAPI "namespace", for
example; "QMP", "QGA" or "QSD". This directive will associate all
subsequent QAPI directives in a document with the specified
namespace. This does not change the visual display of any of the
definitions or index entries, but does change the "Fully Qualified Name"
inside the QAPI domain's object table. This allows for two different
"namespaces" to define entities with otherwise identical names -- which
will come in handy for documenting both QEMU QMP and the QEMU Storage
Daemon.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250313044312.189276-6-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
docs/devel/qapi-domain.rst
docs/sphinx/qapi_domain.py