aboutsummaryrefslogtreecommitdiff
path: root/qapi/misc.json
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2024-02-27 12:39:12 +0100
committerMarkus Armbruster <armbru@redhat.com>2024-03-04 07:12:40 +0100
commit2746f060be18645a688616c4c785bc54201380a3 (patch)
tree99c3678dca44c9cc691034b61ab9b46e68ab9c39 /qapi/misc.json
parent3a025d3d1ffa63903aba7775a1061b0e30da4d13 (diff)
qapi: Move error documentation to new "Errors" sections
Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-ID: <20240227113921.236097-5-armbru@redhat.com>
Diffstat (limited to 'qapi/misc.json')
-rw-r--r--qapi/misc.json10
1 files changed, 8 insertions, 2 deletions
diff --git a/qapi/misc.json b/qapi/misc.json
index 11c55c2b6c..578f574a68 100644
--- a/qapi/misc.json
+++ b/qapi/misc.json
@@ -345,6 +345,8 @@
#
# Returns:
# - @AddfdInfo on success
+#
+# Errors:
# - If file descriptor was not received, GenericError
# - If @fdset-id is a negative value, GenericError
#
@@ -376,6 +378,8 @@
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If @fdset-id or @fd is not found, GenericError
#
# Since: 1.2
@@ -528,8 +532,10 @@
# @option: option name
#
# Returns: list of @CommandLineOptionInfo for all options (or for the
-# given @option). Returns an error if the given @option doesn't
-# exist.
+# given @option).
+#
+# Errors:
+# - if the given @option doesn't exist
#
# Since: 1.5
#