[libvirt] [PATCH] lib: minor fixes to virDomainGetGuestInfo docs

Jonathon Jongsma posted 1 patch 4 years, 7 months ago
Test syntax-check passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20190828182508.13384-1-jjongsma@redhat.com
src/libvirt-domain.c | 16 ++++++++++++----
1 file changed, 12 insertions(+), 4 deletions(-)
[libvirt] [PATCH] lib: minor fixes to virDomainGetGuestInfo docs
Posted by Jonathon Jongsma 4 years, 7 months ago
 - Due to a typo, some of the field names didn't have closing quotes
 - the information about the hostname was accidentally omitted.
 - filesystem total-bytes and used-bytes did not specify data type

Signed-off-by: Jonathon Jongsma <jjongsma@redhat.com>
---
Replacement for patch 1/4. This patch adds type info for filesystem usage
fields ('total-bytes', 'used-bytes' are unsigned long long) as noted by Daniel
Berrange

(Hopefully your mail client threads this email properly)

 src/libvirt-domain.c | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index cea4d2c11b..94d22752ed 100644
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -12237,10 +12237,10 @@ virDomainSetVcpu(virDomainPtr domain,
  *
  *      "user.count" - the number of active users on this domain as an
  *                     unsigned int
- *      "user.<num>.name - username of the user as a string
- *      "user.<num>.domain - domain of the user as a string (may only be
+ *      "user.<num>.name" - username of the user as a string
+ *      "user.<num>.domain" - domain of the user as a string (may only be
  *                           present on certain guest types)
- *      "user.<num>.login-time - the login time of a user in milliseconds
+ *      "user.<num>.login-time" - the login time of a user in milliseconds
  *                               since the epoch as unsigned long long
  *
  * VIR_DOMAIN_GUEST_INFO_OS:
@@ -12282,12 +12282,20 @@ virDomainSetVcpu(virDomainPtr domain,
  *      "fs.<num>.name" - device name in the guest (e.g. "sda1")
  *      "fs.<num>.fstype" - the type of filesystem
  *      "fs.<num>.total-bytes" - the total size of the filesystem
- *      "fs.<num>.used-bytes" - the number of bytes used in the filesystem
+ *      "fs.<num>.used-bytes" - the number of bytes used in the filesystem as
+ *                              unsigned long long
  *      "fs.<num>.disk.count" - the number of disks targeted by this filesystem
+ *                              as unsigned long long
  *      "fs.<num>.disk.<num>.alias" - the device alias of the disk (e.g. sda)
  *      "fs.<num>.disk.<num>.serial" - the serial number of the disk
  *      "fs.<num>.disk.<num>.device" - the device node of the disk
  *
+ * VIR_DOMAIN_GUEST_INFO_HOSTNAME:
+ *  Returns information about the hostname of the domain. The typed
+ *  parameter keys are in this format:
+ *
+ *      "hostname" - the hostname of the domain
+ *
  * Using 0 for @types returns all information groups supported by the given
  * hypervisor.
  *
-- 
2.21.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list