External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-02-01 17:35:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve job info details

Browse Source 
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: Eric Blake <eblake@redhat.com>
This commit is contained in:
Eric Blake 2013-11-15 05:54:33 -07:00
parent 18037b5f1c
commit 6385283add
2 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/libvirt/libvirt.h.in
View File

@ -4067,20 +4067,20 @@ struct _virDomainJobInfo {
/* One of virDomainJobType */
int type;
/* Time is measured in mill-seconds */
/* Time is measured in milliseconds */
unsigned long long timeElapsed; /* Always set */
unsigned long long timeRemaining; /* Only for VIR_DOMAIN_JOB_BOUNDED */
/* 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
* than the final sum of dataProcessed + dataRemaining
* 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
* equal sum of dataProcessed + dataRemaining
* equal the sum of dataProcessed + dataRemaining.
*/
unsigned long long dataTotal;
unsigned long long dataProcessed;

3
src/libvirt.c
View File

@ -18666,6 +18666,9 @@ error:
* Extract information about progress of a background job on a domain.
* 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.
*/
int