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: Eric Blake <eblake@redhat.com>

diff --git a/include/libvirt/libvirt.h.in b/include/libvirt/libvirt.h.in
index 80b2d78345b20bfbdb340f0ebbd56a38af4aff69..d656634bbb10b7df266e02c5ad7fb7561e2385fa 100644 (file)
--- a/include/libvirt/libvirt.h.in
+++ b/include/libvirt/libvirt.h.in
@@ -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;

diff --git a/src/libvirt.c b/src/libvirt.c
index 90608ab87c9c32742cc383e99be486623e73cafe..6a17db8d365c2004de5f3a6174b9f2eb6eb2734b 100644 (file)
--- a/src/libvirt.c
+++ b/src/libvirt.c
@@ -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