Changeset 61937 in vbox for trunk/doc/manual/en_US

Timestamp:

Jun 29, 2016 4:36:07 PM (9 years ago)

Author:

vboxsync

Message:

Renamed the 'VBoxmanage debugvm dumpgueststack' command to just 'stack' and documented it in the manual. Also, default to dump all stacks (untested).

File:

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

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

@@ -39 +39 @@
       <arg>--filename=<replaceable>name</replaceable></arg>
     </cmdsynopsis>
-    <cmdsynopsis id="synopsis-vboxmanage-debugvm-dumpgueststack">
-      <command>VBoxManage debugvm</command>
-      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
-      <arg choice="plain">dumpgueststack</arg>
-      <arg>--cpu=<replaceable>id</replaceable></arg>
-    </cmdsynopsis>
     <cmdsynopsis id="synopsis-vboxmanage-debugvm-info">
       <command>VBoxManage debugvm</command>
@@ -114 +108 @@
       <group><arg>--human-readable</arg><arg>--sh-export</arg><arg>--sh-eval</arg><arg>--cmd-set</arg></group>
       <arg rep="repeat"><replaceable>settings-item</replaceable></arg>
+    </cmdsynopsis>
+    <cmdsynopsis id="synopsis-vboxmanage-debugvm-stack">
+      <command>VBoxManage debugvm</command>
+      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
+      <arg choice="plain">stack</arg>
+      <arg>--cpu=<replaceable>id</replaceable></arg>
     </cmdsynopsis>
     <cmdsynopsis id="synopsis-vboxmanage-debugvm-statistics">
@@ -569 +569 @@
     </refsect2>
 
+    <refsect2 id="vboxmanage-debugvm-stack">
+      <title>debugvm stack</title>
+      <remark role="help-copy-synopsis"/>
+      <para>
+        Unwinds the guest CPU stacks to the best of our ability.  For Windows
+        guest it is recommended to first run the <command>osdetect</command> command.
+      </para>
+      <variablelist>
+        <varlistentry>
+          <term><option>--cpu <replaceable>id</replaceable></option></term>
+          <listitem><para>Selects a single guest CPU to display the stack for.  The default is all CPUs.</para> </listitem>
+        </varlistentry>
+      </variablelist>
+
+    </refsect2>
+
     <refsect2 id="vboxmanage-debugvm-statistics">
       <title>debugvm statistics</title>