From d3a48372a42c62608c2f773376810e6a9c1851fb Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Fri, 13 Jan 2017 15:41:23 +0100 Subject: qapi: add some sections in docs Add some more section titles to organize the documentation we're going to generate. Signed-off-by: Marc-André Lureau Reviewed-by: Markus Armbruster Message-Id: <20170113144135.5150-10-marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster --- qapi/common.json | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'qapi/common.json') diff --git a/qapi/common.json b/qapi/common.json index 624a8619c8..d93f159946 100644 --- a/qapi/common.json +++ b/qapi/common.json @@ -1,6 +1,8 @@ # -*- Mode: Python -*- -# -# QAPI common definitions + +## +# = QAPI common definitions +## ## # @QapiErrorClass: -- cgit v1.2.3-55-g7522 From dd746afbb43989064cb98d2448d066da2e156aa8 Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 15:09:51 +0200 Subject: qmp-commands: move 'query-version' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 27 --------------------------- qapi/common.json | 15 +++++++++++++++ 2 files changed, 15 insertions(+), 27 deletions(-) (limited to 'qapi/common.json') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index d586059c84..cb41253592 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -209,33 +209,6 @@ Note: This command must be issued before issuing any other command. ================= -query-version -------------- - -Show QEMU version. - -Return a json-object with the following information: - -- "qemu": A json-object containing three integer values: - - "major": QEMU's major version (json-int) - - "minor": QEMU's minor version (json-int) - - "micro": QEMU's micro version (json-int) -- "package": package's version (json-string) - -Example: - --> { "execute": "query-version" } -<- { - "return":{ - "qemu":{ - "major":0, - "minor":11, - "micro":5 - }, - "package":"" - } - } - query-commands -------------- diff --git a/qapi/common.json b/qapi/common.json index d93f159946..d6a6d76176 100644 --- a/qapi/common.json +++ b/qapi/common.json @@ -77,6 +77,21 @@ # Returns: A @VersionInfo object describing the current version of QEMU. # # Since: 0.14.0 +# +# Example: +# +# -> { "execute": "query-version" } +# <- { +# "return":{ +# "qemu":{ +# "major":0, +# "minor":11, +# "micro":5 +# }, +# "package":"" +# } +# } +# ## { 'command': 'query-version', 'returns': 'VersionInfo' } -- cgit v1.2.3-55-g7522 From 8b0ffce442b9dbfaac65aa4eccdc4cdf5dc0203b Mon Sep 17 00:00:00 2001 From: Marc-André Lureau Date: Thu, 23 Jun 2016 15:10:40 +0200 Subject: qmp-commands: move 'query-commands' doc to schema Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 28 ---------------------------- qapi/common.json | 17 +++++++++++++++++ 2 files changed, 17 insertions(+), 28 deletions(-) (limited to 'qapi/common.json') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index cb41253592..0e0416e3ba 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -209,34 +209,6 @@ Note: This command must be issued before issuing any other command. ================= -query-commands --------------- - -List QMP available commands. - -Each command is represented by a json-object, the returned value is a json-array -of all commands. - -Each json-object contain: - -- "name": command's name (json-string) - -Example: - --> { "execute": "query-commands" } -<- { - "return":[ - { - "name":"query-balloon" - }, - { - "name":"system_powerdown" - } - ] - } - -Note: This example has been shortened as the real response is too long. - query-qmp-schema ---------------- diff --git a/qapi/common.json b/qapi/common.json index d6a6d76176..b626647b2f 100644 --- a/qapi/common.json +++ b/qapi/common.json @@ -114,6 +114,23 @@ # Returns: A list of @CommandInfo for all supported commands # # Since: 0.14.0 +# +# Example: +# +# -> { "execute": "query-commands" } +# <- { +# "return":[ +# { +# "name":"query-balloon" +# }, +# { +# "name":"system_powerdown" +# } +# ] +# } +# +# Note: This example has been shortened as the real response is too long. +# ## { 'command': 'query-commands', 'returns': ['CommandInfo'] } -- cgit v1.2.3-55-g7522