Changeset 92538 in vbox for trunk/doc

Timestamp:

Nov 22, 2021 1:53:20 AM (3 years ago)

Author:

vboxsync

Message:

VBoxManage/modifyvm,showvminfo: Added --testing-enabled=bool, --testing-mmio=bool and --testing-cfg-dwordN=val switches to modifyvm for easy VMMDev/Testing config. Display these settings in showvminfo.

File:

• trunk/doc/manual/en_US/man_VBoxManage-modifyvm.xml (modified) (3 diffs)

trunk/doc/manual/en_US/man_VBoxManage-modifyvm.xml

@@ -617 +617 @@
       <arg>--pci-detach=<replaceable>host-PCI-address</replaceable></arg>
     </cmdsynopsis>
+
+    <cmdsynopsis id="synopsis-vboxmanage-modifyvm-testing">
+      <command>VBoxManage modifyvm</command>
+      <group choice="req">
+        <arg choice="plain"><replaceable>uuid</replaceable></arg>
+        <arg choice="plain"><replaceable>vmname</replaceable></arg>
+      </group>
+      <arg>--testing-enabled=<group choice="plain"><arg choice="plain">on</arg><arg choice="plain">off</arg></group></arg>
+      <arg>--testing-mmio=<group choice="plain"><arg choice="plain">on</arg><arg choice="plain">off</arg></group></arg>
+      <arg>--testing-cfg-dword<replaceable>idx</replaceable>=<replaceable>value</replaceable></arg>
+    </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -2652 +2663 @@
       </variablelist>
     </refsect2>
+    <refsect2 id="vboxmanage-modifyvm-testing">
+      <title>Testing (ValidationKit / Bootsector)</title>
+      <para>
+        These options are for configuring the testing functionality of the VMM
+        device and almost exclusively used by the bootsector testcases in the
+        ValidationKit.
+      </para>
+      <remark role="help-copy-synopsis"/>
+      <variablelist>
+        <varlistentry>
+          <term><option>--testing-enabled=on | off</option></term>
+          <listitem><para>Enabled the testing functionality of the VMMDev. See VMMDevTesting.h for details. </para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--testing-mmio=on | off</option></term>
+          <listitem><para>Enabled the MMIO region of the VMMDev testing feature.</para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--testing-cfg-dword<replaceable>idx</replaceable>=<replaceable>value</replaceable></option></term>
+          <listitem><para>
+                This sets one of the 10 dword configuration values. The
+                <replaceable>idx</replaceable> must be in the range 0 thru 9.
+                The <replaceable>value</replaceable> is limited to 32 bits (dword).
+            </para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+
   </refsect1>
 
@@ -2672 +2711 @@
     <title>See Also</title>
     <para>
+      <xref linkend="vboxmanage-showvminfo" />,
       <xref linkend="vboxmanage-controlvm" />,
       <xref linkend="vboxmanage-createvm" />,
-      <xref linkend="vboxmanage-list" />,
       <xref linkend="vboxmanage-startvm" />
+      <xref linkend="vboxmanage-list" />
     </para>
   </refsect1>