]> xenbits.xensource.com Git - libvirt.git/commitdiff
docs: Add documentation for new attribute tray of disk target
authorOsier Yang <jyang@redhat.com>
Wed, 14 Mar 2012 15:26:46 +0000 (23:26 +0800)
committerOsier Yang <jyang@redhat.com>
Fri, 23 Mar 2012 15:10:30 +0000 (23:10 +0800)
Example XML:

    <disk type='file' device='cdrom'>
      <driver name='qemu' type='raw'/>
      <source file='/tmp/cdrom.img'/>
      <target dev='hdd' bus='ide' tray='open'/>
    </disk>

docs/formatdomain.html.in
docs/schemas/domaincommon.rng

index 21372b7cd40bfda135fbd3627c857e6087d4282c..814e270fda3576de389b6cc930a259c8e122fb84 100644 (file)
     &lt;/disk&gt;
     &lt;disk type='block' device='cdrom'&gt;
       &lt;driver name='qemu' type='raw'/&gt;
-      &lt;target dev='hdc' bus='ide'/&gt;
+      &lt;target dev='hdc' bus='ide' tray='open'/&gt;
       &lt;readonly/&gt;
     &lt;/disk&gt;
     &lt;disk type='block' device='lun'&gt;
         possible values are driver specific, with typical values being
         "ide", "scsi", "virtio", "xen", "usb" or "sata". If omitted, the bus
         type is inferred from the style of the device name. eg, a device named
-        'sda' will typically be exported using a SCSI bus.
+        'sda' will typically be exported using a SCSI bus. The optional
+        attribute <code>tray</code> indicates the tray status of the
+        removable disks (i.e. CDROM or Floppy disk), the value can be either
+        "open" or "closed", defaults to "closed". NB, the value of
+        <code>tray</code> could be updated while the domain is running.
         <span class="since">Since 0.0.3; <code>bus</code> attribute since 0.4.3;
-        "usb" attribute value since after 0.4.4; "sata" attribute value since
-        0.9.7</span></dd>
+        <code>tray</code> attribute since 0.9.11; "usb" attribute value since
+        after 0.4.4; "sata" attribute value since 0.9.7</span>
+      </dd>
       <dt><code>iotune</code></dt>
       <dd>The optional <code>iotune</code> element provides the
         ability to provide additional per-device I/O tuning, with
index f62969193c4f31b63c2a3e7aed7c37d0df0eef7c..1f5232ef15a765ffde59142bbe3d762f901e3771 100644 (file)
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="tray">
+          <choice>
+            <value>open</value>
+            <value>closed</value>
+          </choice>
+        </attribute>
+      </optional>
     </element>
   </define>
   <!--