From: Jonathon Jongsma <jjongsma@redhat.com>
Date: Tue, 27 Aug 2019 20:35:53 +0000 (-0500)
Subject: lib: minor fixes to virDomainGetGuestInfo docs
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=56cac62bfd216307b6fa30a1ce351b66d4da0452;p=libvirt.git

lib: minor fixes to virDomainGetGuestInfo docs

Due to a typo, some of the field names didn't have closing quotes,
the information about the hostname was omitted and there was an
empty line missing after filesystem info description (which helps
our docs generator produce better looking HTML).

Signed-off-by: Jonathon Jongsma <jjongsma@redhat.com>
Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
---

diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index cea4d2c11b..bbd2dc2e6e 100644
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -12237,11 +12237,11 @@ 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
- *                           present on certain guest types)
- *      "user.<num>.login-time - the login time of a user in milliseconds
- *                               since the epoch as unsigned long long
+ *      "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
+ *                                since the epoch as unsigned long long
  *
  * VIR_DOMAIN_GUEST_INFO_OS:
  *  Return information about the operating system running within the guest. The
@@ -12276,6 +12276,7 @@ virDomainSetVcpu(virDomainPtr domain,
  * VIR_DOMAIN_GUEST_INFO_FILESYSTEM:
  *  Returns inforamtion about the filesystems within the domain.  The typed
  *  parameter keys are in this format:
+ *
  *      "fs.count" - the number of filesystems defined on this domain
  *                   as an unsigned int
  *      "fs.<num>.mountpoint" - the path to the mount point for the filesystem
@@ -12288,6 +12289,12 @@ virDomainSetVcpu(virDomainPtr domain,
  *      "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.
  *