External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-22 05:35:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

virDomainSnapshotAlignDisks: Improve function comment

Browse Source 
Add description of arguments, reword the description for clarity, and
fix improper argument names mentioned in the existing description.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
Peter Krempa 2022-01-12 12:46:19 +01:00
parent 82e0a1878e
commit 94686f1919
1 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/conf/snapshot_conf.c
View File

@ -622,13 +622,22 @@ virDomainSnapshotDefAssignExternalNames(virDomainSnapshotDef *def)
}
/* Align def->disks to def->parent.dom. Sort the list of def->disks,
* filling in any missing disks or snapshot state defaults given by
* the domain, with a fallback to a passed in default. Convert paths
* to disk targets for uniformity. Issue an error and return -1 if
* any def->disks[n]->name appears more than once or does not map to
* dom->disks. If require_match, also ensure that there is no
* conflicting requests for both internal and external snapshots. */
/**
* virDomainSnapshotAlignDisks:
* @snapdef: Snapshot definition to align
* @default_snapshot: snapshot location to assign to disks which don't have any
* @require_match: Require that all disks use the same snapshot mode
*
* Align snapdef->disks to snapdef->parent.dom, filling in any missing disks or
* snapshot state defaults given by the domain, with a fallback to
* @default_snapshot. Ensure that there are no duplicate snapshot disk
* definitions in @snapdef and there are no disks described in @snapdef but
* missing from the domain definition.
*
* Convert paths to disk targets for uniformity.
*
* On error -1 is returned and a libvirt error is reported.
*/
int
virDomainSnapshotAlignDisks(virDomainSnapshotDef *snapdef,
int default_snapshot,