aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc-André Lureau <marcandre.lureau@redhat.com>2016-06-23 13:39:05 +0200
committerMarkus Armbruster <armbru@redhat.com>2017-01-16 09:15:29 +0100
commit43fef34a2938c2feda5b668bba01a7fb01a19308 (patch)
tree914bcbd9d404f01c8bf40383c5da70b0c2895dac
parentf5ad8e87c737996abe5e61124dc07adb2b610dac (diff)
qmp-commands: move 'add-fd' doc to schema
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
-rw-r--r--docs/qmp-commands.txt28
-rw-r--r--qapi-schema.json8
2 files changed, 8 insertions, 28 deletions
diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt
index d727f36bbe..21f3ddf9d6 100644
--- a/docs/qmp-commands.txt
+++ b/docs/qmp-commands.txt
@@ -688,34 +688,6 @@ Arguments:
Returns: Nothing on success
If "device" does not exist or cannot be determined, DeviceNotFound
-add-fd
--------
-
-Add a file descriptor, that was passed via SCM rights, to an fd set.
-
-Arguments:
-
-- "fdset-id": The ID of the fd set to add the file descriptor to.
- (json-int, optional)
-- "opaque": A free-form string that can be used to describe the fd.
- (json-string, optional)
-
-Return a json-object with the following information:
-
-- "fdset-id": The ID of the fd set that the fd was added to. (json-int)
-- "fd": The file descriptor that was received via SCM rights and added to the
- fd set. (json-int)
-
-Example:
-
--> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
-<- { "return": { "fdset-id": 1, "fd": 3 } }
-
-Notes:
-
-(1) The list of fd sets is shared by all monitor connections.
-(2) If "fdset-id" is not specified, a new fd set will be created.
-
remove-fd
---------
diff --git a/qapi-schema.json b/qapi-schema.json
index b5c01367e4..35a2399cf1 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -4373,7 +4373,9 @@
# @opaque: #optional A free-form string that can be used to describe the fd.
#
# Returns: @AddfdInfo on success
+#
# If file descriptor was not received, FdNotSupplied
+#
# If @fdset-id is a negative value, InvalidParameterValue
#
# Notes: The list of fd sets is shared by all monitor connections.
@@ -4381,6 +4383,12 @@
# If @fdset-id is not specified, a new fd set will be created.
#
# Since: 1.2.0
+#
+# Example:
+#
+# -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
+# <- { "return": { "fdset-id": 1, "fd": 3 } }
+#
##
{ 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
'returns': 'AddfdInfo' }