mirrors/qemu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

qapi: nail down convention that Errors sections are lists

Browse Source 
By unstated convention, Errors sections are rST lists.  Document the
convention, and make the one exception conform.

Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240626222128.406106-10-jsnow@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
John Snow 2024-06-26 18:21:15 -04:00 committed by Markus Armbruster
parent 9f2b848857
commit b32a6b62a8
2 changed files with 8 additions and 1 deletions

7
docs/devel/qapi-code-gen.rst

@ -1011,6 +1011,13 @@ like this::
"Returns" and "Errors" sections are only valid for commands. They "Returns" and "Errors" sections are only valid for commands. They
document the success and the error response, respectively. document the success and the error response, respectively.
"Errors" sections should be formatted as an rST list, each entry
detailing a relevant error condition. For example::
# Errors:
# - If @device does not exist, DeviceNotFound
# - Any other error returns a GenericError.
A "Since: x.y.z" tagged section lists the release that introduced the A "Since: x.y.z" tagged section lists the release that introduced the
definition. definition.

2
qapi/transaction.json

@ -235,7 +235,7 @@
# additional detail. # additional detail.
# #
# Errors: # Errors:
# Any errors from commands in the transaction # - Any errors from commands in the transaction
# #
# Note: The transaction aborts on the first failure. Therefore, there # Note: The transaction aborts on the first failure. Therefore, there
# will be information on only one failed operation returned in an # will be information on only one failed operation returned in an