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

[Justin Clift]

On 13/01/2011, at 9:06 AM, Justin Clift wrote:
> On 13/01/2011, at 8:54 AM, Eric Blake wrote:
>> On 01/12/2011 02:24 PM, Justin Clift wrote:
>>> Addresses BZ # 622534:
>>> 
>>> https://bugzilla.redhat.com/show_bug.cgi?id=622534
>>> ---
>>> tools/virsh.pod |   28 ++++++++++++++++++----------
>>> 1 files changed, 18 insertions(+), 10 deletions(-)
>>> 
>>> diff --git a/tools/virsh.pod b/tools/virsh.pod
>>> index 0e03d68..b4c6ff7 100644
>>> --- a/tools/virsh.pod
>>> +++ b/tools/virsh.pod

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.

      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.

+ Justin