[libvirt] [PATCH 05/22] Improve documentation of virConnectGetCPUModelNames

Jiri Denemark posted 22 patches 7 years, 7 months ago
[libvirt] [PATCH 05/22] Improve documentation of virConnectGetCPUModelNames
Posted by Jiri Denemark 7 years, 7 months ago
Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
---
 src/libvirt-host.c | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/libvirt-host.c b/src/libvirt-host.c
index 76087badd8..ed689b9ec2 100644
--- 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 capabalities of
+ * any 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).
-- 
2.17.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
Re: [libvirt] [PATCH 05/22] Improve documentation of virConnectGetCPUModelNames
Posted by Collin Walling 7 years, 6 months ago
On 05/16/2018 04:39 AM, Jiri Denemark wrote:
> Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
> ---
>  src/libvirt-host.c | 8 +++++++-
>  1 file changed, 7 insertions(+), 1 deletion(-)
> 
> diff --git a/src/libvirt-host.c b/src/libvirt-host.c
> index 76087badd8..ed689b9ec2 100644
> --- 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 capabalities of

s/capabalities/capabilities

> + * any 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).
> 

Other than that:

Reviewed-by: Collin Walling <walling@linux.ibm.com>

-- 
Respectfully,
- Collin Walling

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
Re: [libvirt] [PATCH 05/22] Improve documentation of virConnectGetCPUModelNames
Posted by Kashyap Chamarthy 7 years, 6 months ago
On Wed, May 16, 2018 at 10:39:24AM +0200, Jiri Denemark wrote:
> Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
> ---
>  src/libvirt-host.c | 8 +++++++-
>  1 file changed, 7 insertions(+), 1 deletion(-)
> 
> diff --git a/src/libvirt-host.c b/src/libvirt-host.c
> index 76087badd8..ed689b9ec2 100644
> --- 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 capabalities of
> + * any hypervisor. 

s/any hypervisor/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).

Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>

-- 
/kashyap

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
Re: [libvirt] [PATCH 05/22] Improve documentation of virConnectGetCPUModelNames
Posted by Ján Tomko 7 years, 6 months ago
On Wed, May 16, 2018 at 10:39:24AM +0200, Jiri Denemark wrote:
>Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
>---
> src/libvirt-host.c | 8 +++++++-
> 1 file changed, 7 insertions(+), 1 deletion(-)
>
>diff --git a/src/libvirt-host.c b/src/libvirt-host.c
>index 76087badd8..ed689b9ec2 100644
>--- 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,

Should there be a comma?

>+ * there's no limit imposed by libvirt) and it does not reflect capabalities of
>+ * any hypervisor. See the XML returned by virConnectGetDomainCapabilities()
>+ * for a list of CPU models supported by libvirt for domains created on a
>+ * specific hypervisor.
>  *

Reviewed-by: Ján Tomko <jtomko@redhat.com>

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