[libvirt] [PATCH] docs: mention hostname subtlety

An off-list bug report mentioned some confusion where the public documentation of libvirt.c:virConnectGetHostname did not match the private documentation of util/virutil.c:virGetHostname. * src/libvirt.c (virConnectGetHostname): Tweak docs. Signed-off-by: Eric Blake <eblake@redhat.com> --- src/libvirt.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/libvirt.c b/src/libvirt.c index 20a2d4c..a6fcab0 100644 --- a/src/libvirt.c +++ b/src/libvirt.c @@ -1701,9 +1701,10 @@ error: * virConnectGetHostname: * @conn: pointer to a hypervisor connection * - * This returns the system hostname on which the hypervisor is - * running (the result of the gethostname system call). If - * we are connected to a remote system, then this returns the + * This returns a system hostname on which the hypervisor is + * running (based on the result of the gethostname system call, but + * possibly expanded to a fully-qualified domain name via getaddrinfo). + * If we are connected to a remote system, then this returns the * hostname of the remote system. * * Returns the hostname which must be freed by the caller, or -- 1.8.3.1

On 09/12/13 21:20, Eric Blake wrote:
An off-list bug report mentioned some confusion where the public documentation of libvirt.c:virConnectGetHostname did not match the private documentation of util/virutil.c:virGetHostname.
* src/libvirt.c (virConnectGetHostname): Tweak docs.
Signed-off-by: Eric Blake <eblake@redhat.com> --- src/libvirt.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
ACK. Peter

On 09/13/2013 01:41 AM, Peter Krempa wrote:
On 09/12/13 21:20, Eric Blake wrote:
An off-list bug report mentioned some confusion where the public documentation of libvirt.c:virConnectGetHostname did not match the private documentation of util/virutil.c:virGetHostname.
* src/libvirt.c (virConnectGetHostname): Tweak docs.
Signed-off-by: Eric Blake <eblake@redhat.com> --- src/libvirt.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
ACK.
Thanks; pushed. -- Eric Blake eblake redhat com +1-919-301-3266 Libvirt virtualization library http://libvirt.org
participants (2)
-
Eric Blake
-
Peter Krempa