motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-07-27 04:13:53 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs/qapi-domain: add qapi:alternate directive

Browse source 
Add the .. qapi:alternate:: directive, object, and qapi:alt:`name`
cross-reference role.

Add the "Alternatives:" field list for describing alternate choices. Like
other field lists that reference QAPI types, a forthcoming commit will
add cross-referencing support to this field.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250311034303.75779-21-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
John Snow 2025-03-10 23:42:18 -04:00 • committed by Markus Armbruster
parent 902c9b0e34
commit bac3f1313c
1 changed files with 20 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/sphinx/qapi_domain.py
View file

@ -329,6 +329,23 @@ class QAPIEnum(QAPIObject):
)
class QAPIAlternate(QAPIObject):
"""Description of a QAPI Alternate."""
doc_field_types = QAPIObject.doc_field_types.copy()
doc_field_types.extend(
[
# :alt type name: descr
TypedField(
"alternative",
label=_("Alternatives"),
names=("alt",),
can_collapse=False,
),
]
)
class QAPIModule(QAPIDescription):
"""
Directive to mark description of a new module.
@ -456,6 +473,7 @@ class QAPIDomain(Domain):
"module": ObjType(_("module"), "mod", "any"),
"command": ObjType(_("command"), "cmd", "any"),
"enum": ObjType(_("enum"), "enum", "type", "any"),
"alternate": ObjType(_("alternate"), "alt", "type", "any"),
}
# Each of these provides a rST directive,
@ -464,6 +482,7 @@ class QAPIDomain(Domain):
"module": QAPIModule,
"command": QAPICommand,
"enum": QAPIEnum,
"alternate": QAPIAlternate,
}
# These are all cross-reference roles; e.g.
@ -473,6 +492,7 @@ class QAPIDomain(Domain):
"mod": QAPIXRefRole(),
"cmd": QAPIXRefRole(),
"enum": QAPIXRefRole(),
"alt": QAPIXRefRole(),
# reference any data type (excludes modules, commands, events)
"type": QAPIXRefRole(),
"any": QAPIXRefRole(), # reference *any* type of QAPI object.