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>

diff --git a/src/libvirt-domain-checkpoint.c b/src/libvirt-domain-checkpoint.c
index 8a7b55dcd20750794b35b602ade31ef70605b59a..e9af8e4cf044993b5d41e45cebe6276b6efcddb5 100644 (file)
--- a/src/libvirt-domain-checkpoint.c
+++ b/src/libvirt-domain-checkpoint.c
@@ -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.