diff mbox

[02/30] qmp-commands: move 'query-name' doc to schema

Message ID 20160913130209.695-3-marcandre.lureau@redhat.com
State New
Headers show

Commit Message

Marc-André Lureau Sept. 13, 2016, 1:01 p.m. UTC
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---
 docs/qmp-commands.txt | 14 --------------
 qapi-schema.json      | 12 +++++++++---
 2 files changed, 9 insertions(+), 17 deletions(-)

Comments

Eric Blake Sept. 20, 2016, 6:05 p.m. UTC | #1
On 09/13/2016 08:01 AM, Marc-André Lureau wrote:
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> ---
>  docs/qmp-commands.txt | 14 --------------
>  qapi-schema.json      | 12 +++++++++---
>  2 files changed, 9 insertions(+), 17 deletions(-)
> 

> +++ b/qapi-schema.json
> @@ -102,9 +102,9 @@
>  #
>  # Guest name information.
>  #
> -# @name: #optional The name of the guest
> +# @name: #optional the name of the guest
>  #
> -# Since 0.14.0
> +# Since: 0.14.0

You are doing more than just moving documentation; you are also
normalizing how the existing documentation is presented. Might be worth
mentioning that in various commit messages along the series, or to
rebase things to do the cleanups (uncontroversially safe to do now)
separately from the doc motion (motion is easier to review when there
are no other changes thrown in the mix, and we already know that we are
at risk of merge conflicts causing either you or other developers some
rebase churn, where we have to be careful we don't lose contents).

Reviewed-by: Eric Blake <eblake@redhat.com>
diff mbox

Patch

diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt
index 2d65f24..4c9ccfb 100644
--- a/docs/qmp-commands.txt
+++ b/docs/qmp-commands.txt
@@ -2590,20 +2590,6 @@  Example:
       }
    }
 
-query-name
-----------
-
-Show VM name.
-
-Return a json-object with the following information:
-
-- "name": VM's name (json-string, optional)
-
-Example:
-
--> { "execute": "query-name" }
-<- { "return": { "name": "qemu-name" } }
-
 query-uuid
 ----------
 
diff --git a/qapi-schema.json b/qapi-schema.json
index f0e2d2c..accb28b 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -102,9 +102,9 @@ 
 #
 # Guest name information.
 #
-# @name: #optional The name of the guest
+# @name: #optional the name of the guest
 #
-# Since 0.14.0
+# Since: 0.14.0
 ##
 { 'struct': 'NameInfo', 'data': {'*name': 'str'} }
 
@@ -115,7 +115,13 @@ 
 #
 # Returns: @NameInfo of the guest
 #
-# Since 0.14.0
+# Since: 0.14.0
+#
+# Example:
+#
+# -> { "execute": "query-name" }
+# <- { "return": { "name": "qemu-name" } }
+#
 ##
 { 'command': 'query-name', 'returns': 'NameInfo' }