]> git.ipfire.org Git - thirdparty/qemu.git/commit
docs/qapi-domain: add "Return:" field lists
authorJohn Snow <jsnow@redhat.com>
Tue, 11 Mar 2025 03:42:16 +0000 (23:42 -0400)
committerMarkus Armbruster <armbru@redhat.com>
Tue, 11 Mar 2025 09:10:56 +0000 (10:10 +0100)
commit8b77f8d5730003d868b5748af5438c43d17f8c3a
tree49a1c42354fa87de5ee5cac5b874e2695964cc8c
parent9605c2047766367160304645b2db5464275d83d3
docs/qapi-domain: add "Return:" field lists

Add "Return:" field list syntax to QAPI Commands.

Like "Arguments:" and "Errors:", the type name isn't currently processed
for cross-referencing, but this will be addressed in a forthcoming
commit.

The syntax of the new field is:

:return TypeName: description
   description cont'd

This patch adds "Return" as a GroupedField, which means that multiple
return values can be annotated - this is only done because Sphinx does
not support mandatory type arguments to Ungrouped fields. Because we
want to cross-reference this type information later, we want to make the
type argument mandatory. As a result, you can technically add multiple
:return: fields, though I'm not aware of any circumstance in which you'd
need or want to. Recommendation: "Don't do that, then." The forthcoming
QAPIDoc transmogrifier does not, in fact, ever "do that".

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