]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: Update doc for virDomainSave and virDomainRestore
authorPurna Pavan Chandra Aekkaladevi <paekkaladevi@linux.microsoft.com>
Mon, 11 Mar 2024 09:44:06 +0000 (09:44 +0000)
committerMichal Privoznik <mprivozn@redhat.com>
Wed, 20 Mar 2024 13:05:38 +0000 (14:05 +0100)
ch_driver expects path to be of a dir for save/restore. So, update
the documentation at global API as well.

Signed-off-by: Purna Pavan Chandra Aekkaladevi <paekkaladevi@linux.microsoft.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
src/libvirt-domain.c

index 9e3c61b66aa867ddc4834596be4f740db1f1c1f3..7c6b93963ca68719ba30b3b9a3c222eedcfd573d 100644 (file)
@@ -852,11 +852,11 @@ virDomainPMWakeup(virDomainPtr dom,
 /**
  * virDomainSave:
  * @domain: a domain object
- * @to: path for the output file
+ * @to: path for the output save file / directory
  *
- * This method will suspend a domain and save its memory contents to
- * a file on disk. After the call, if successful, the domain is not
- * listed as running anymore (this ends the life of a transient domain).
+ * This method will suspend a domain and save its memory contents to a file or
+ * direcotry (based on the vmm) on disk. After the call, if successful,the domain
+ * is not listed as running anymore (this ends the life of a transient domain).
  * Use virDomainRestore() to restore a domain after saving.
  *
  * See virDomainSaveFlags() and virDomainSaveParams() for more control.
@@ -1053,7 +1053,7 @@ virDomainSaveParams(virDomainPtr domain,
 /**
  * virDomainRestore:
  * @conn: pointer to the hypervisor connection
- * @from: path to the input file
+ * @from: path to the input save file / directory
  *
  * This method will restore a domain saved to disk by virDomainSave().
  *