qmp-commands: move 'block-commit' 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
							
								
									280c4b3cf2
								
							
						
					
					
						commit
						f44fb58f35
					
				| 
						 | 
				
			
			@ -208,62 +208,6 @@ Example:
 | 
			
		|||
                                               "base": "/tmp/master.qcow2" } }
 | 
			
		||||
<- { "return": {} }
 | 
			
		||||
 | 
			
		||||
block-commit
 | 
			
		||||
------------
 | 
			
		||||
 | 
			
		||||
Live commit of data from overlay image nodes into backing nodes - i.e., writes
 | 
			
		||||
data between 'top' and 'base' into 'base'.
 | 
			
		||||
 | 
			
		||||
Arguments:
 | 
			
		||||
 | 
			
		||||
- "job-id": Identifier for the newly-created block job. If omitted,
 | 
			
		||||
            the device name will be used. (json-string, optional)
 | 
			
		||||
- "device": The device name or node-name of a root node (json-string)
 | 
			
		||||
- "base": The file name of the backing image to write data into.
 | 
			
		||||
          If not specified, this is the deepest backing image
 | 
			
		||||
          (json-string, optional)
 | 
			
		||||
- "top":  The file name of the backing image within the image chain,
 | 
			
		||||
          which contains the topmost data to be committed down. If
 | 
			
		||||
          not specified, this is the active layer. (json-string, optional)
 | 
			
		||||
 | 
			
		||||
- backing-file:     The backing file string to write into the overlay
 | 
			
		||||
                    image of 'top'.  If 'top' is the active layer,
 | 
			
		||||
                    specifying a backing file string is an error. This
 | 
			
		||||
                    filename is not validated.
 | 
			
		||||
 | 
			
		||||
                    If a pathname string is such that it cannot be
 | 
			
		||||
                    resolved by QEMU, that means that subsequent QMP or
 | 
			
		||||
                    HMP commands must use node-names for the image in
 | 
			
		||||
                    question, as filename lookup methods will fail.
 | 
			
		||||
 | 
			
		||||
                    If not specified, QEMU will automatically determine
 | 
			
		||||
                    the backing file string to use, or error out if
 | 
			
		||||
                    there is no obvious choice. Care should be taken
 | 
			
		||||
                    when specifying the string, to specify a valid
 | 
			
		||||
                    filename or protocol.
 | 
			
		||||
                    (json-string, optional) (Since 2.1)
 | 
			
		||||
 | 
			
		||||
          If top == base, that is an error.
 | 
			
		||||
          If top == active, the job will not be completed by itself,
 | 
			
		||||
          user needs to complete the job with the block-job-complete
 | 
			
		||||
          command after getting the ready event. (Since 2.0)
 | 
			
		||||
 | 
			
		||||
          If the base image is smaller than top, then the base image
 | 
			
		||||
          will be resized to be the same size as top.  If top is
 | 
			
		||||
          smaller than the base image, the base will not be
 | 
			
		||||
          truncated.  If you want the base image size to match the
 | 
			
		||||
          size of the smaller top, you can safely truncate it
 | 
			
		||||
          yourself once the commit operation successfully completes.
 | 
			
		||||
          (json-string)
 | 
			
		||||
- "speed":  the maximum speed, in bytes per second (json-int, optional)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
Example:
 | 
			
		||||
 | 
			
		||||
-> { "execute": "block-commit", "arguments": { "device": "virtio0",
 | 
			
		||||
                                              "top": "/tmp/snap1.qcow2" } }
 | 
			
		||||
<- { "return": {} }
 | 
			
		||||
 | 
			
		||||
drive-backup
 | 
			
		||||
------------
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -1267,7 +1267,7 @@
 | 
			
		|||
# @device:  the device name or node-name of a root node
 | 
			
		||||
#
 | 
			
		||||
# @base:   #optional The file name of the backing image to write data into.
 | 
			
		||||
#                    If not specified, this is the deepest backing image
 | 
			
		||||
#                    If not specified, this is the deepest backing image.
 | 
			
		||||
#
 | 
			
		||||
# @top:    #optional The file name of the backing image within the image chain,
 | 
			
		||||
#                    which contains the topmost data to be committed down. If
 | 
			
		||||
| 
						 | 
				
			
			@ -1313,6 +1313,13 @@
 | 
			
		|||
#
 | 
			
		||||
# Since: 1.3
 | 
			
		||||
#
 | 
			
		||||
# Example:
 | 
			
		||||
#
 | 
			
		||||
# -> { "execute": "block-commit",
 | 
			
		||||
#      "arguments": { "device": "virtio0",
 | 
			
		||||
#                     "top": "/tmp/snap1.qcow2" } }
 | 
			
		||||
# <- { "return": {} }
 | 
			
		||||
#
 | 
			
		||||
##
 | 
			
		||||
{ 'command': 'block-commit',
 | 
			
		||||
  'data': { '*job-id': 'str', 'device': 'str', '*base': 'str', '*top': 'str',
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
		Reference in New Issue