[libvirt] [PATCH] doc: cpu topology values should be equal to maxmium vcpus

[Eric Blake]

On 05/28/2013 08:53 PM, Guannan Ren wrote:
> ---
>  docs/formatdomain.html.in | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
> index 755d084..27c1580 100644
> --- a/docs/formatdomain.html.in
> +++ b/docs/formatdomain.html.in
> @@ -941,7 +941,9 @@
>          virtual CPU provided to the guest. Three non-zero values have to be
>          given for <code>sockets</code>, <code>cores</code>, and
>          <code>threads</code>: total number of CPU sockets, number of cores per
> -        socket, and number of threads per core, respectively.</dd>
> +        socket, and number of threads per core, respectively. The maximum number
> +        of virtual CPUs is defined by <code>vcpu</code> element, the product of
> +        the three valuses should be equal to the maximum vcpus.</dd>

s/valuses/values/

Again, if we are going to document that they must be equal, then the
code should match; otherwise, if we are going to allow a difference
between the two, then the wording should be a bit nicer ("It is
recommended that if both maxvcpu and topology are provided, then the two
numbers should match").  Or maybe a one-sided restriction makes sense,
where maxvcpus can be less than or equal, but not greater than, an
explicit topology.

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

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 621 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20130528/0e78eccb/attachment-0001.sig>