[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[libvirt] [libvirt-virshcmdref 09/10] update documentation for command setvcpus



---
 source/setvcpus.xml |   72 ++++++++++++++++++++++++++++++++++++++++++++++++--
 1 files changed, 69 insertions(+), 3 deletions(-)

diff --git a/source/setvcpus.xml b/source/setvcpus.xml
index 77f3295..4cc65c8 100644
--- a/source/setvcpus.xml
+++ b/source/setvcpus.xml
@@ -9,7 +9,64 @@
     </text>
   </description>
 
-  <options />
+  <options>
+    <parameter requirement="required">
+      <keyword requirement="optional">--domain</keyword>
+      <value type="string" requirement="required">domain</value>
+      <description>
+        <text>
+          domain name, id or uuid
+        </text>
+        <text>
+          "--domain" itself is optional
+        </text>
+      </description>
+    </parameter>
+    <parameter requirement="required">
+      <keyword requirement="optional">--count</keyword>
+      <value type="number" requirement="required">count</value>
+      <description>
+        <text>
+          number of virtual CPUs
+        </text>
+        <text>
+          "--count" itself is optional
+        </text>
+      </description>
+    </parameter>
+    <parameter requirement="optional">
+      <keyword requirement="optional">--maximum</keyword>
+      <description>
+        <text>
+          set maximum limit on next boot
+        </text>
+      </description>
+    </parameter>
+    <parameter requirement="optional">
+      <keyword requirement="optional">--config</keyword>
+      <description>
+        <text>
+          affect next boot
+        </text>
+      </description>
+    </parameter>
+    <parameter requirement="optional">
+      <keyword requirement="optional">--live</keyword>
+      <description>
+        <text>
+          affect running domain
+        </text>
+      </description>
+    </parameter>
+    <parameter requirement="optional">
+      <keyword requirement="optional">--current</keyword>
+      <description>
+        <text>
+          affect curent domain
+        </text>
+      </description>
+    </parameter>
+  </options>
 
   <availability from="0.0.1" />
  
@@ -19,6 +76,15 @@
 
   <examples type="fullcontext" />
 
-  <reference type="seealso" />
-
+  <reference type="seealso">
+    <item>
+      <link type="internal" href="vcpucount" />
+      <name>
+        vcpucount
+      </name>
+      <description>
+        show domain vcpu counts
+      </description>
+    </item>
+  </reference>
 </command>
-- 
1.7.3.1


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]