Changeset 89697 in vbox for trunk/doc

Timestamp:

Jun 15, 2021 9:54:12 AM (4 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

145145

Message:

FE/VBoxManage: Add guestsample sub-command for debugvm, bugref:10025

File:

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

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

@@ -122 +122 @@
       <arg>--descriptions</arg>
       <arg>--pattern=<replaceable>pattern</replaceable></arg>
+    </cmdsynopsis>
+    <cmdsynopsis id="synopsis-vboxmanage-debugvm-guestsample">
+      <command>VBoxManage debugvm</command>
+      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
+      <arg choice="plain">guestsample</arg>
+      <arg>--filename=<replaceable>filename</replaceable></arg>
+      <arg>--sample-interval-us=<replaceable>interval</replaceable></arg>
+      <arg>--sample-time-us=<replaceable>time</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
@@ -610 +618 @@
     </refsect2>
 
+    <refsect2 id="vboxmanage-debugvm-guestsample">
+      <title>debugvm guestsample</title>
+      <remark role="help-copy-synopsis"/>
+      <para>
+        Creates a sample report of the guest activity.
+      </para>
+      <para>
+        Retrieves the filename to dump the report to.
+      </para>
+      <variablelist>
+        <varlistentry>
+          <term><option>--filename=<replaceable>filename</replaceable></option></term>
+          <listitem><para>The filename to dump the sample report to.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--sample-interval-us=<replaceable>interval</replaceable></option></term>
+          <listitem><para>The interval in microseconds between guest samples.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--sample-time-us=<replaceable>time</replaceable></option></term>
+          <listitem><para>The amount of microseconds to take guest samples.</para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+
+    </refsect2>
+
   </refsect1>