[libvirt] [PATCH v4 1/4] lib: minor fixes to virDomainGetGuestInfo docs

[Michal Privoznik]

On 8/27/19 10:35 PM, Jonathon Jongsma wrote:
> Due to a typo, some of the field names didn't have closing quotes and
> the information about the hostname was omitted.
> 
> Signed-off-by: Jonathon Jongsma <jjongsma at redhat.com>
> ---
>   src/libvirt-domain.c | 12 +++++++++---
>   1 file changed, 9 insertions(+), 3 deletions(-)

Couple of small nit picks:

> 
> diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
> index cea4d2c11b..bc24090e2e 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)

This not not aligned which triggers my OCD O:-)

> - *      "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:
> @@ -12288,6 +12288,12 @@ virDomainSetVcpu(virDomainPtr domain,

When touching this you may put a blank line just before this block and 
after filesystem description as it helps our docs generator generate 
better looking HTML. See:

  libvirt.git/docs/html/libvirt-libvirt-domain.html#virDomainGetGuestInfo


>    *      "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.
>    *
> 

Reviewed-by: Michal Privoznik <mprivozn at redhat.com>

Michal