api-docs: Fix description of virConnectGetType() API function

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, and provide a hint on how to learn about
full capabilities.

Signed-off-by: Michal Novotny <minovotn@redhat.com>
Signed-off-by: Eric Blake <eblake@redhat.com>

diff --git a/src/libvirt.c b/src/libvirt.c
index 665b30be5bd50ef6156d6f5500f4a30173d2f33b..20a2d4c005cfeccc3f062cc8b9c725f6bd5694a6 100644 (file)
--- a/src/libvirt.c
+++ b/src/libvirt.c
@@ -1581,7 +1581,11 @@ 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; 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().
  *
  * Returns NULL in case of error, a static zero terminated string otherwise.
  *