diff options
| author | John Snow <jsnow@redhat.com> | 2025-03-13 00:43:05 -0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2025-03-14 07:31:57 +0100 |
| commit | 9ca404f0043d63043bfed3af8da3adedc062cb13 (patch) | |
| tree | ba485ea777cd2a519460a750685e6e26b037c304 /docs | |
| parent | 74d40b011c27dc343ad56022a322d212135c96ed (diff) | |
| download | qemu-9ca404f0043d63043bfed3af8da3adedc062cb13.zip qemu-9ca404f0043d63043bfed3af8da3adedc062cb13.tar.gz qemu-9ca404f0043d63043bfed3af8da3adedc062cb13.tar.bz2 | |
docs/qapi-domain: add :namespace: override option
Akin to the :module: override option, the :namespace: options allows you
to forcibly override the contextual namespace associatied with a
definition.
We don't necessarily actually need this, but I felt compelled to stick
close to how the Python domain works that offers context overrides.
As of this commit, it is possible to add e.g. ":namespace: QMP" to any
QAPI directive to forcibly associate that definition with a given
namespace.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250313044312.189276-5-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/devel/qapi-domain.rst | 2 | ||||
| -rw-r--r-- | docs/sphinx/qapi_domain.py | 5 |
2 files changed, 5 insertions, 2 deletions
diff --git a/docs/devel/qapi-domain.rst b/docs/devel/qapi-domain.rst index 1475870..51b2832 100644 --- a/docs/devel/qapi-domain.rst +++ b/docs/devel/qapi-domain.rst @@ -466,6 +466,8 @@ QAPI standard options All QAPI directives -- *except* for module -- support these common options. +* ``:namespace: name`` -- This option allows you to override the + namespace association of a given definition. * ``:module: modname`` -- Borrowed from the Python domain, this option allows you to override the module association of a given definition. * ``:since: x.y`` -- Allows the documenting of "Since" information, which is diff --git a/docs/sphinx/qapi_domain.py b/docs/sphinx/qapi_domain.py index 48a082d..6485c43 100644 --- a/docs/sphinx/qapi_domain.py +++ b/docs/sphinx/qapi_domain.py @@ -294,8 +294,9 @@ class QAPIObject(QAPIDescription): ) option_spec.update( { - # Borrowed from the Python domain: - "module": directives.unchanged, # Override contextual module name + # Context overrides: + "namespace": directives.unchanged, + "module": directives.unchanged, # These are QAPI originals: "since": directives.unchanged, "ifcond": directives.unchanged, |