[libvirt] [PATCH 3/6] doc: clarify documentation for vcpu order

Make it clear that vcpu order is valid for online vcpus only and state that it has to be specified for all vcpus or not provided at all. Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=1370043 --- docs/formatdomain.html.in | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index f2de8e4..f1dadc6 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -564,11 +564,12 @@ all disabled vcpus must be hotpluggable. Valid values are <code>yes</code> and <code>no</code>. - <code>order</code> allows to specify the order to add the vcpus. For - hypervisors/platforms that require to insert multiple vcpus at once + <code>order</code> allows to specify the order to add the online vcpus. + For hypervisors/platforms that require to insert multiple vcpus at once the order may be be duplicated accross all vcpus that need to be enabled at once. Specifying order is not necessary, vcpus are then - added in an arbitrary order. + added in an arbitrary order. If order info is used, it must be used for + all online vcpus. Note that hypervisors may create hotpluggable vcpus differently from boot vcpus thus special initialization may be necessary. -- 2.8.2