checkpoint: Mention that VIR_DOMAIN_CHECKPOINT_XML_SIZE may require running vm

The qemu implementation requires that the VM associated with the
checkpoint is running when checking the size. Mention this possibility
with the flag.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
Peter Krempa 2020-11-03 12:30:53 +01:00
parent dddd442798
commit 1bb33357ea
1 changed files with 3 additions and 1 deletions

View File

@ -192,7 +192,9 @@ virDomainCheckpointCreateXML(virDomainPtr domain,
* attribute that shows an estimate of the current size in bytes that
* have been dirtied between the time the checkpoint was created and the
* current point in time. Note that updating the size may be expensive and
* data will be inaccurate once guest OS writes to the disk.
* data will be inaccurate once guest OS writes to the disk. Also note that
* hypervisors may require that the domain associated with @checkpoint is
* running when VIR_DOMAIN_CHECKPOINT_XML_SIZE is used.
*
* Returns a 0 terminated UTF-8 encoded XML instance or NULL in case
* of error. The caller must free() the returned value.