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

[libvirt] [libvirt-virshcmdref 02/10] update documentation for command update-device



---
 source/attach-device.xml |    9 ++++++
 source/detach-device.xml |    9 ++++++
 source/update-device.xml |   66 ++++++++++++++++++++++++++++++++++++++++++++-
 3 files changed, 82 insertions(+), 2 deletions(-)

diff --git a/source/attach-device.xml b/source/attach-device.xml
index aab8313..a44be0d 100644
--- a/source/attach-device.xml
+++ b/source/attach-device.xml
@@ -153,5 +153,14 @@ virsh # <bold>attach-device</bold> <value>example-domain</value> <value>/tmp/new
         Detach a device from an XML file
       </description>
     </item>
+    <item>
+      <link type="internal" href="update-device" />
+      <name>
+        update-device
+      </name>
+      <description>
+        Update a device from an XML file
+      </description>
+    </item>
   </reference>
 </command>
diff --git a/source/detach-device.xml b/source/detach-device.xml
index 6262d49..405ce01 100644
--- a/source/detach-device.xml
+++ b/source/detach-device.xml
@@ -136,6 +136,15 @@ virsh # <bold>detach-device</bold> <value>example-domain</value> <value>/tmp/nic
         Attach a device from an XML file
       </description>
     </item>
+    <item>
+      <link type="internal" href="update-device" />
+      <name>
+        update-device
+      </name>
+      <description>
+        Update a device from an XML file
+      </description>
+    </item>
   </reference>
 
 </command>
diff --git a/source/update-device.xml b/source/update-device.xml
index 6354b5a..8d9ab8c 100644
--- a/source/update-device.xml
+++ b/source/update-device.xml
@@ -9,7 +9,50 @@
     </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">--file</keyword>
+      <value type="string" requirement="required">file</value>
+      <description>
+        <text>
+          the XML file describing the device to be updated, with
+          a root element of something that belongs inside &lt;devices&gt;
+          of domain xml
+        </text>
+        <text>
+          "--file" itself is optional
+        </text>
+      </description>
+    </parameter>
+    <parameter requirement="optional">
+      <keyword requirement="required">--persistent</keyword>
+      <description>
+        <text>
+          with this option, the XML file of domain will be updated
+        </text>
+      </description>
+    </parameter>
+    <parameter requirement="optional">
+      <keyword requirement="required">--force</keyword>
+      <description>
+        <text>
+          force device update
+        </text>
+      </description>
+    </parameter>
+  </options>
 
   <availability from="0.8.0" />
  
@@ -19,6 +62,25 @@
 
   <examples type="fullcontext" />
 
-  <reference type="seealso" />
+  <reference type="seealso">
+    <item>
+      <link type="internal" href="attach-device" />
+      <name>
+        attach-device
+      </name>
+      <description>
+        attach a device from an XML file
+      </description>
+    </item>
+    <item>
+      <link type="internal" href="detach-device" />
+      <name>
+        detach-device
+      </name>
+      <description>
+        Detach a device from an XML file
+      </description>
+    </item>
+  </reference>
 
 </command>
-- 
1.7.3.1


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