[libvirt] [PATCH] docs: clarify that virsh setvcpus and setmem only work on active domains

[Eric Blake]

On 01/13/2011 09:36 AM, Justin Clift wrote:
> How's this for new virsh text for the setvcpus bit?
> 
>   setvcpus domain-id count optional --maximum --config --live
>       Change the number of virtual CPUs active in a guest domain.  By default, this command works on active
>       guest domains.  To change the settings for an inactive guest domain, use the --config flag.
> 
>       The count value may be limited by host, hypervisor, or a limit coming from the original description of the
>       guest domain.
> 
>       For Xen, you can only adjust the virtual CPUs of a running domain if the domain is paravirtualized.

Since both of these paragraphs talk about limitations on using the
command, I could see merging them if you wanted, but that's up to you.

> 
>       If the --config flag is specified, the change is made to the stored XML configuration for the guest domain,
>       and will only take effect when the guest domain is next started.
> 
>       If --live is specified, the domain must be active, and the change takes place immediately.  Both the
>       --config and --live flags may be specified together if supported by the hypervisor.
> 
>       When neither the --config nor --live flags are given, the --live flag is assumed and the guest domain must
>       be active.  In this situation it is up to the hypervisor whether the --config flag is also assumed, and
>       therefore whether the XML configuration is adjusted to make the change persistent.
> 
>       The --maximum flag controls the maximum number of virtual cpus that can be hot-plugged the next time the
>       domain is booted.  As such, it must only be used with the --config flag, and not with the --live option.

That reads well to me.  Thanks for persisting on this.

-- 
Eric Blake   eblake at redhat.com    +1-801-349-2682
Libvirt virtualization library http://libvirt.org

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