From: Peter Krempa <pkrempa@redhat.com>
Date: Thu, 25 Aug 2016 15:41:44 +0000 (-0400)
Subject: doc: clarify documentation for vcpu order
X-Git-Tag: v2.2.0-rc1~5
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=54147fd9be31838904f6f2251510da91a1bd0ca7;p=thirdparty%2Flibvirt.git

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
---

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index f2de8e461f..f1dadc61f6 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.