aboutsummaryrefslogtreecommitdiff
path: root/qapi/net.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/net.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/net.json')
-rw-r--r--qapi/net.json14
1 files changed, 11 insertions, 3 deletions
diff --git a/qapi/net.json b/qapi/net.json
index 1374caac64..09e644a742 100644
--- a/qapi/net.json
+++ b/qapi/net.json
@@ -19,6 +19,8 @@
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If @name is not a valid network device, DeviceNotFound
#
# Since: 0.14
@@ -46,6 +48,8 @@
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If @type is not a valid network backend, DeviceNotFound
#
# Example:
@@ -67,6 +71,8 @@
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If @id is not a valid network backend, DeviceNotFound
#
# Since: 0.14
@@ -828,9 +834,11 @@
# @name: net client name
#
# Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
-# Returns an error if the given @name doesn't exist, or given NIC
-# doesn't support rx-filter querying, or given net client isn't a
-# NIC.
+#
+# Errors:
+# - if the given @name doesn't exist
+# - if the given NIC doesn't support rx-filter querying
+# - if the given net client isn't a NIC
#
# Since: 1.6
#