qmp-commands: move 'query-command-line-options' doc to schema
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
		
							parent
							
								
									4e022d01ee
								
							
						
					
					
						commit
						e26a0d0070
					
				| 
						 | 
				
			
			@ -1163,46 +1163,6 @@ Example:
 | 
			
		|||
      ]
 | 
			
		||||
   }
 | 
			
		||||
 | 
			
		||||
query-command-line-options
 | 
			
		||||
--------------------------
 | 
			
		||||
 | 
			
		||||
Show command line option schema.
 | 
			
		||||
 | 
			
		||||
Return a json-array of command line option schema for all options (or for
 | 
			
		||||
the given option), returning an error if the given option doesn't exist.
 | 
			
		||||
 | 
			
		||||
Each array entry contains the following:
 | 
			
		||||
 | 
			
		||||
- "option": option name (json-string)
 | 
			
		||||
- "parameters": a json-array describes all parameters of the option:
 | 
			
		||||
    - "name": parameter name (json-string)
 | 
			
		||||
    - "type": parameter type (one of 'string', 'boolean', 'number',
 | 
			
		||||
              or 'size')
 | 
			
		||||
    - "help": human readable description of the parameter
 | 
			
		||||
              (json-string, optional)
 | 
			
		||||
    - "default": default value string for the parameter
 | 
			
		||||
                 (json-string, optional)
 | 
			
		||||
 | 
			
		||||
Example:
 | 
			
		||||
 | 
			
		||||
-> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
 | 
			
		||||
<- { "return": [
 | 
			
		||||
        {
 | 
			
		||||
            "parameters": [
 | 
			
		||||
                {
 | 
			
		||||
                    "name": "romfile",
 | 
			
		||||
                    "type": "string"
 | 
			
		||||
                },
 | 
			
		||||
                {
 | 
			
		||||
                    "name": "bootindex",
 | 
			
		||||
                    "type": "number"
 | 
			
		||||
                }
 | 
			
		||||
            ],
 | 
			
		||||
            "option": "option-rom"
 | 
			
		||||
        }
 | 
			
		||||
     ]
 | 
			
		||||
   }
 | 
			
		||||
 | 
			
		||||
query-rx-filter
 | 
			
		||||
---------------
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -5136,6 +5136,28 @@
 | 
			
		|||
#          @option).  Returns an error if the given @option doesn't exist.
 | 
			
		||||
#
 | 
			
		||||
# Since: 1.5
 | 
			
		||||
#
 | 
			
		||||
# Example:
 | 
			
		||||
#
 | 
			
		||||
# -> { "execute": "query-command-line-options",
 | 
			
		||||
#      "arguments": { "option": "option-rom" } }
 | 
			
		||||
# <- { "return": [
 | 
			
		||||
#         {
 | 
			
		||||
#             "parameters": [
 | 
			
		||||
#                 {
 | 
			
		||||
#                     "name": "romfile",
 | 
			
		||||
#                     "type": "string"
 | 
			
		||||
#                 },
 | 
			
		||||
#                 {
 | 
			
		||||
#                     "name": "bootindex",
 | 
			
		||||
#                     "type": "number"
 | 
			
		||||
#                 }
 | 
			
		||||
#             ],
 | 
			
		||||
#             "option": "option-rom"
 | 
			
		||||
#         }
 | 
			
		||||
#      ]
 | 
			
		||||
#    }
 | 
			
		||||
#
 | 
			
		||||
##
 | 
			
		||||
{'command': 'query-command-line-options', 'data': { '*option': 'str' },
 | 
			
		||||
 'returns': ['CommandLineOptionInfo'] }
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
		Reference in New Issue