From: Peter Krempa <pkrempa@redhat.com>
Date: Wed, 24 Jul 2019 12:50:03 +0000 (+0200)
Subject: qemu: blockjob: Document qemuBlockJobRegister
X-Git-Tag: v5.6.0-rc1~70
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=35a97e4532a2c465a9b4a7a84b39f109f08d79df;p=thirdparty%2Flibvirt.git

qemu: blockjob: Document qemuBlockJobRegister

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
ACKed-by: Eric Blake <eblake@redhat.com>
---

diff --git a/src/qemu/qemu_blockjob.c b/src/qemu/qemu_blockjob.c
index e63dc49e92..ac7b3a0aef 100644
--- a/src/qemu/qemu_blockjob.c
+++ b/src/qemu/qemu_blockjob.c
@@ -117,6 +117,16 @@ qemuBlockJobDataNew(qemuBlockJobType type,
 }
 
 
+/**
+ * qemuBlockJobRegister:
+ * @job: job to register
+ * @vm: domain to register @job with
+ * @disk: disk to register @job with
+ * @savestatus: save the status XML after registering
+ *
+ * This function registers @job with @disk and @vm and records it into the status
+ * xml (if @savestatus is true).
+ */
 int
 qemuBlockJobRegister(qemuBlockJobDataPtr job,
                      virDomainObjPtr vm,