[libvirt] [PATCH v2 19/25] doc: Document quirk of getting block job info for a 'backup' blockjob

[Peter Krempa]

The stats reported for a blockjob which is member of a domain pull
backup refer to the utilization of the scratch file rather than the
progress of the backup as the progress of the backup depends on the
client. Note this quirk in the docs.

Signed-off-by: Peter Krempa <pkrempa at redhat.com>
---
 src/libvirt-domain.c | 4 ++++
 tools/virsh.pod      | 4 ++++
 2 files changed, 8 insertions(+)

diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index f873246ace..793eceb39f 100644
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -9949,6 +9949,10 @@ virDomainBlockJobAbort(virDomainPtr dom, const char *disk,
  * and was no-op. In this case libvirt reports cur = 1 and end = 1.
  * Since 2.3.0.
  *
+ * Note that the progress reported for blockjobs corresponding to a pull-mode
+ * backup don't report progress of the backup but rather usage of temporary
+ * space required for the backup.
+ *
  * Returns -1 in case of failure, 0 when nothing found, 1 when info was found.
  */
 int
diff --git a/tools/virsh.pod b/tools/virsh.pod
index b04f7c0fdc..244895ceb4 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -994,6 +994,10 @@ I<--bytes> with a scaled value permits a finer granularity to be selected.
 A scaled value used without I<--bytes> will be rounded down to MiB/s. Note
 that the I<--bytes> may be unsupported by the hypervisor.

+Note that the progress reported for blockjobs corresponding to a pull-mode
+backup don't report progress of the backup but rather usage of temporary
+space required for the backup.
+
 =item B<blockpull> I<domain> I<path> [I<bandwidth>] [I<--bytes>] [I<base>]
 [I<--wait> [I<--verbose>] [I<--timeout> B<seconds>] [I<--async>]]
 [I<--keep-relative>]
-- 
2.23.0