]> git.ipfire.org Git - thirdparty/qemu.git/commit
docs/qapi-domain: add qapi:enum directive
authorJohn Snow <jsnow@redhat.com>
Tue, 11 Mar 2025 03:42:17 +0000 (23:42 -0400)
committerMarkus Armbruster <armbru@redhat.com>
Tue, 11 Mar 2025 09:10:56 +0000 (10:10 +0100)
commit902c9b0e34049283628c4bd00a6841e13b754fec
tree6f356cf5c0d0629550d99240b7b0c025b755bb5e
parent8b77f8d5730003d868b5748af5438c43d17f8c3a
docs/qapi-domain: add qapi:enum directive

Add the .. qapi:enum:: directive, object, and :qapi:enum:`name`
cross-reference role.

Add the :value name: field list for documenting Enum values.

Of note, also introduce a new "type" role that is intended to be used by
other QAPI object directives to cross-reference arbitrary QAPI type
names, but will exclude commands, events, and modules from
consideration.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250311034303.75779-20-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
docs/sphinx/qapi_domain.py