Changeset 31226 in vbox

Timestamp:

Jul 29, 2010 5:24:47 PM (14 years ago)

Author:

vboxsync

Message:

Main: fix API documentation inaccuracies

File:

• trunk/src/VBox/Main/idl/VirtualBox.xidl (modified) (7 diffs)

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -6548 +6548 @@
 
 
-        The virtual machine's <link to="IMachine::state">state</link> is changed to "DeletingSnapshot"
-        while this operation is in progress.
+        The virtual machine's <link to="IMachine::state">state</link> is
+        changed to "DeletingSnapshot" or "DeletingSnapshotOnline" while this
+        operation is in progress.
 
         <note>
@@ -6559 +6560 @@
         </note>
         <result name="VBOX_E_INVALID_VM_STATE">
-          Virtual machine is running.
+          The running virtual machine prevents deleting this snapshot. This
+          happens only in very specific situations, usually snapshots can be
+          deleted without trouble while a VM is running. The error message
+          text explains the reason for the failure.
         </result>
       </desc>
@@ -8465 +8469 @@
       <desc>
         Allow using this medium concurrently by several machines.
-        <note>This is a stub value. Not usable until this note is removed.</note>
+        <note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
       </desc>
     </const>
@@ -8507 +8511 @@
     <const name="Diff" value="0x20000">
       <desc>
-        Fixed image. Only allowed for base images.
+        Differencing image. Only allowed for child images.
       </desc>
     </const>
@@ -8670 +8674 @@
       <h3>Medium types</h3>
 
-      There are three types of medium behavior (see <link to="MediumType" />):
-      "normal", "immutable" and "writethrough", represented by the
+      There are four types of medium behavior (see <link to="MediumType" />):
+      "normal", "immutable", "writethrough" and "shareable", represented by the
       <link to="#type"/> attribute. The type of the medium defines how the
       medium is attached to a virtual machine and what happens when a
@@ -8696 +8700 @@
       using the <link to="#children"/> attribute.
 
-      Note that the type of all differencing media is "Normal"; all other
+      Note that the type of all differencing media is "normal"; all other
       values are meaningless for them. Base media may be of any type.
 
@@ -8794 +8798 @@
             also as designed. This also means that writethrough hard disks cannot
             have other hard disks linked to them at all.</li>
+        <li><b>Shareable</b> hard disks are always attached <b>directly</b>,
+            also as designed. This also means that shareable hard disks cannot
+            have other hard disks linked to them at all. They behave almost
+            like writethrough hard disks, except that shareable hard disks can
+            be attached to several virtual machines which are running, allowing
+            concurrent accesses. You need special cluster software running in
+            the virtual machines to make use of such disks.</li>
       </ul>