From: Marc-André Lureau <marcandre.lureau@redhat.com>
Date: Thu, 23 Jun 2016 13:12:36 +0000 (+0200)
Subject: qmp-commands: move 'query-rocker-ports' doc to schema
X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=7e20b16919e0a8c5040a280416b14ba8c3078fe1;p=qemu.git

qmp-commands: move 'query-rocker-ports' doc to schema

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---

diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt
index 903b065c12..f4a5dbf9bd 100644
--- a/docs/qmp-commands.txt
+++ b/docs/qmp-commands.txt
@@ -312,22 +312,6 @@ Example:
 -> { "execute": "trace-event-set-state", "arguments": { "name": "qemu_memalign", "enable": "true" } }
 <- { "return": {} }
 
-Show rocker switch ports
-------------------------
-
-Arguments:
-
-- "name": switch name
-
-Example:
-
--> { "execute": "query-rocker-ports", "arguments": { "name": "sw1" } }
-<- { "return": [ {"duplex": "full", "enabled": true, "name": "sw1.1",
-                  "autoneg": "off", "link-up": true, "speed": 10000},
-                 {"duplex": "full", "enabled": true, "name": "sw1.2",
-                  "autoneg": "off", "link-up": true, "speed": 10000}
-   ]}
-
 Show rocker switch OF-DPA flow tables
 -------------------------------------
 
diff --git a/qapi/rocker.json b/qapi/rocker.json
index 547864bb90..19ae4982eb 100644
--- a/qapi/rocker.json
+++ b/qapi/rocker.json
@@ -90,11 +90,21 @@
 ##
 # @query-rocker-ports:
 #
-# Return rocker switch information.
+# Return rocker switch port information.
 #
-# Returns: @Rocker information
+# Returns: a list of @RockerPort information
 #
 # Since: 2.4
+#
+# Example:
+#
+# -> { "execute": "query-rocker-ports", "arguments": { "name": "sw1" } }
+# <- { "return": [ {"duplex": "full", "enabled": true, "name": "sw1.1",
+#                   "autoneg": "off", "link-up": true, "speed": 10000},
+#                  {"duplex": "full", "enabled": true, "name": "sw1.2",
+#                   "autoneg": "off", "link-up": true, "speed": 10000}
+#    ]}
+#
 ##
 { 'command': 'query-rocker-ports',
   'data': { 'name': 'str' },