mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-10-30 18:03:32 +00:00
snapshots: Trivial doc improvements
Fix an incorrect @xmlDesc comment, as well as adding more details about which XML element should be root. Signed-off-by: Eric Blake <eblake@redhat.com>
This commit is contained in:
parent
1b57269cbc
commit
21dd152927
@ -98,11 +98,11 @@ virDomainSnapshotGetConnect(virDomainSnapshotPtr snapshot)
|
|||||||
/**
|
/**
|
||||||
* virDomainSnapshotCreateXML:
|
* virDomainSnapshotCreateXML:
|
||||||
* @domain: a domain object
|
* @domain: a domain object
|
||||||
* @xmlDesc: string containing an XML description of the domain
|
* @xmlDesc: string containing an XML description of the domain snapshot
|
||||||
* @flags: bitwise-OR of virDomainSnapshotCreateFlags
|
* @flags: bitwise-OR of virDomainSnapshotCreateFlags
|
||||||
*
|
*
|
||||||
* Creates a new snapshot of a domain based on the snapshot xml
|
* Creates a new snapshot of a domain based on the snapshot xml
|
||||||
* contained in xmlDesc.
|
* contained in xmlDesc, with a top-level element <domainsnapshot>.
|
||||||
*
|
*
|
||||||
* If @flags is 0, the domain can be active, in which case the
|
* If @flags is 0, the domain can be active, in which case the
|
||||||
* snapshot will be a full system snapshot (capturing both disk state,
|
* snapshot will be a full system snapshot (capturing both disk state,
|
||||||
@ -247,7 +247,8 @@ virDomainSnapshotCreateXML(virDomainPtr domain,
|
|||||||
* @snapshot: a domain snapshot object
|
* @snapshot: a domain snapshot object
|
||||||
* @flags: bitwise-OR of supported virDomainSnapshotXMLFlags
|
* @flags: bitwise-OR of supported virDomainSnapshotXMLFlags
|
||||||
*
|
*
|
||||||
* Provide an XML description of the domain snapshot.
|
* Provide an XML description of the domain snapshot, with a top-level
|
||||||
|
* element of <domainsnapshot>.
|
||||||
*
|
*
|
||||||
* No security-sensitive data will be included unless @flags contains
|
* No security-sensitive data will be included unless @flags contains
|
||||||
* VIR_DOMAIN_SNAPSHOT_XML_SECURE; this flag is rejected on read-only
|
* VIR_DOMAIN_SNAPSHOT_XML_SECURE; this flag is rejected on read-only
|
||||||
|
Loading…
Reference in New Issue
Block a user