]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
conf: Document virDomainDiskSourceFormat
authorPeter Krempa <pkrempa@redhat.com>
Wed, 20 Mar 2019 13:13:42 +0000 (14:13 +0100)
committerPeter Krempa <pkrempa@redhat.com>
Wed, 3 Apr 2019 09:58:09 +0000 (11:58 +0200)
Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
src/conf/domain_conf.c

index 5f55a7382dfe7a218300e86296d52d26fb3ebe97..265d44eea29dbcccecfe58661197c47c84be8b6b 100644 (file)
@@ -23716,6 +23716,18 @@ virDomainDiskSourceFormatPrivateData(virBufferPtr buf,
 }
 
 
+/**
+ * virDomainDiskSourceFormat:
+ * @buf: output buffer
+ * @src: storage source definition to format
+ * @policy: startup policy attribute value, if necessary
+ * @attrIndex: the 'index' attribute of <source> is formatted if true
+ * @flags: XML formatter flags
+ * @xmlopt: XML formatter callbacks
+ *
+ * Formats @src into a <source> element. Note that this doesn't format the
+ * 'type' and 'format' properties of @src.
+ */
 int
 virDomainDiskSourceFormat(virBufferPtr buf,
                           virStorageSourcePtr src,