Commit dd49d9d8 authored by Wainer dos Santos Moschetta's avatar Wainer dos Santos Moschetta Committed by Markus Armbruster
Browse files

qmp: Add examples to qom list, get, and set commands 



Added examples for the qom-list, qom-get, and qom-set
commands in qapi misc JSON file.

Signed-off-by: default avatarWainer dos Santos Moschetta <wainersm@redhat.com>
Message-Id: <20181228194442.3506-1-wainersm@redhat.com>
Reviewed-by: default avatarMarkus Armbruster <armbru@redhat.com>
Signed-off-by: default avatarMarkus Armbruster <armbru@redhat.com>
parent a9529100

qapi/misc.json

+36 −0
Original line number Diff line number Diff line
@@ -1380,6 +1380,16 @@ 
#          object.

#

# Since: 1.2

#

# Example:

#

# -> { "execute": "qom-list",

#      "arguments": { "path": "/chardevs" } }

# <- { "return": [ { "name": "type", "type": "string" },

#                  { "name": "parallel0", "type": "child<chardev-vc>" },

#                  { "name": "serial0", "type": "child<chardev-vc>" },

#                  { "name": "mon0", "type": "child<chardev-stdio>" } ] }

#

##

{ 'command': 'qom-list',

  'data': { 'path': 'str' },
@@ -1417,6 +1427,23 @@ 
#          returned as #int.

#

# Since: 1.2

#

# Example:

#

# 1. Use absolute path

#

# -> { "execute": "qom-get",

#      "arguments": { "path": "/machine/unattached/device[0]",

#                     "property": "hotplugged" } }

# <- { "return": false }

#

# 2. Use partial path

#

# -> { "execute": "qom-get",

#      "arguments": { "path": "unattached/sysbus",

#                     "property": "type" } }

# <- { "return": "System" }

#

##

{ 'command': 'qom-get',

  'data': { 'path': 'str', 'property': 'str' },
@@ -1436,6 +1463,15 @@ 
#         for a description of type mapping.

#

# Since: 1.2

#

# Example:

#

# -> { "execute": "qom-set",

#      "arguments": { "path": "/machine",

#                     "property": "graphics",

#                     "value": false } }

# <- { "return": {} }

#

##

{ 'command': 'qom-set',

  'data': { 'path': 'str', 'property': 'str', 'value': 'any' },