提交 6385283a 编写于 作者: E Eric Blake

docs: improve job info details

Noticed while revieweing the patches for qemu's new migration state.

* include/libvirt/libvirt.h.in (_virDomainJobInfo): Fix typo,
grammar.
* src/libvirt.c (virDomainGetJobInfo): Add cross reference.
Signed-off-by: NEric Blake <eblake@redhat.com>
上级 18037b5f
...@@ -4067,20 +4067,20 @@ struct _virDomainJobInfo { ...@@ -4067,20 +4067,20 @@ struct _virDomainJobInfo {
/* One of virDomainJobType */ /* One of virDomainJobType */
int type; int type;
/* Time is measured in mill-seconds */ /* Time is measured in milliseconds */
unsigned long long timeElapsed; /* Always set */ unsigned long long timeElapsed; /* Always set */
unsigned long long timeRemaining; /* Only for VIR_DOMAIN_JOB_BOUNDED */ unsigned long long timeRemaining; /* Only for VIR_DOMAIN_JOB_BOUNDED */
/* Data is measured in bytes unless otherwise specified /* Data is measured in bytes unless otherwise specified
* and is measuring the job as a whole * and is measuring the job as a whole.
* *
* For VIR_DOMAIN_JOB_UNBOUNDED, dataTotal may be less * For VIR_DOMAIN_JOB_UNBOUNDED, dataTotal may be less
* than the final sum of dataProcessed + dataRemaining * than the final sum of dataProcessed + dataRemaining
* in the event that the hypervisor has to repeat some * in the event that the hypervisor has to repeat some
* data eg due to dirtied pages during migration * data, such as due to dirtied pages during migration.
* *
* For VIR_DOMAIN_JOB_BOUNDED, dataTotal shall always * For VIR_DOMAIN_JOB_BOUNDED, dataTotal shall always
* equal sum of dataProcessed + dataRemaining * equal the sum of dataProcessed + dataRemaining.
*/ */
unsigned long long dataTotal; unsigned long long dataTotal;
unsigned long long dataProcessed; unsigned long long dataProcessed;
......
...@@ -18666,6 +18666,9 @@ error: ...@@ -18666,6 +18666,9 @@ error:
* Extract information about progress of a background job on a domain. * Extract information about progress of a background job on a domain.
* Will return an error if the domain is not active. * Will return an error if the domain is not active.
* *
* This function returns a limited amount of information in comparison
* to virDomainGetJobStats().
*
* Returns 0 in case of success and -1 in case of failure. * Returns 0 in case of success and -1 in case of failure.
*/ */
int int
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册