[libvirt] [PATCH] api-docs: Fix description of virConnectGetType() API function

2013-09-11 Thread Michal Novotny
This fixes the description of virConnectGetType() API function in
API documentation to match the real functionality that it can be
used to get driver name.

Signed-off-by: Michal Novotny minov...@redhat.com
---
 src/libvirt.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/libvirt.c b/src/libvirt.c
index 665b30b..a1d33b6 100644
--- a/src/libvirt.c
+++ b/src/libvirt.c
@@ -1581,7 +1581,8 @@ virConnectSupportsFeature(virConnectPtr conn, int feature)
  * virConnectGetType:
  * @conn: pointer to the hypervisor connection
  *
- * Get the name of the Hypervisor software used.
+ * Get the name of the Hypervisor driver used. This is merely the driver name 
so for KVM
+ * it is still returning QEMU as QEMU driver is being used for KVM 
virtualization as well.
  *
  * Returns NULL in case of error, a static zero terminated string otherwise.
  *
-- 
1.7.11.7

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


Re: [libvirt] [PATCH] api-docs: Fix description of virConnectGetType() API function

2013-09-11 Thread Eric Blake
On 09/11/2013 06:19 AM, Michal Novotny wrote:
 This fixes the description of virConnectGetType() API function in
 API documentation to match the real functionality that it can be
 used to get driver name.
 
 Signed-off-by: Michal Novotny minov...@redhat.com
 ---
  src/libvirt.c | 3 ++-
  1 file changed, 2 insertions(+), 1 deletion(-)
 
 diff --git a/src/libvirt.c b/src/libvirt.c
 index 665b30b..a1d33b6 100644
 --- a/src/libvirt.c
 +++ b/src/libvirt.c
 @@ -1581,7 +1581,8 @@ virConnectSupportsFeature(virConnectPtr conn, int 
 feature)
   * virConnectGetType:
   * @conn: pointer to the hypervisor connection
   *
 - * Get the name of the Hypervisor software used.
 + * Get the name of the Hypervisor driver used. This is merely the driver 
 name so for KVM
 + * it is still returning QEMU as QEMU driver is being used for KVM 
 virtualization as well.

ACK to the idea; the wording was a bit awkward and it was longer than 80
columns.  Here's what I pushed, adding my name to S-o-B to reflect my
changes:

 * Get the name of the Hypervisor driver used. This is merely the driver
 * name; for example, both KVM and QEMU guests are serviced by the
 * driver for the qemu:// URI, so a return of QEMU does not indicate
 * whether KVM acceleration is present.  For more details about the
 * hypervisor, use virConnectGetCapabilities().

-- 
Eric Blake   eblake redhat com+1-919-301-3266
Libvirt virtualization library http://libvirt.org



signature.asc
Description: OpenPGP digital signature
--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list