Improve documentation of virConnectGetCPUModelNames

Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
Reviewed-by: Collin Walling <walling@linux.ibm.com>
Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>

diff --git a/src/libvirt-host.c b/src/libvirt-host.c
index 76087badd8e3c42544f972ca8dea1b68c27bdda1..9cd7fa4425cd63c31c96f143fbbecc51d392affb 100644 (file)
--- a/src/libvirt-host.c
+++ b/src/libvirt-host.c
@@ -1003,7 +1003,13 @@ virConnectCompareCPU(virConnectPtr conn,
  *          NULL if only the list length is needed.
  * @flags: extra flags; not used yet, so callers should always pass 0.
  *
- * Get the list of supported CPU models for a specific architecture.
+ * Get the list of CPU models supported by libvirt for a specific architecture.
+ *
+ * The returned list limits CPU models usable with libvirt (empty list means
+ * there's no limit imposed by libvirt) and it does not reflect capabilities of
+ * any particular hypervisor. See the XML returned by
+ * virConnectGetDomainCapabilities() for a list of CPU models supported by
+ * libvirt for domains created on a specific hypervisor.
  *
  * Returns -1 on error, number of elements in @models on success (0 means
  * libvirt accepts any CPU model).