Changeset 94172 in vbox for trunk

Timestamp:

Mar 11, 2022 2:24:52 PM (3 years ago)

Author:

vboxsync

Message:

doc/manual,FE/VBoxManage: Convert adoptstate command to refentry documentation, bugref:9186

Location:

trunk

Files:

• doc/manual/Config.kmk (modified) (1 diff)
• doc/manual/en_US/man_VBoxManage-adoptstate.xml (modified) (3 diffs)
• doc/manual/en_US/user_VBoxManage.xml (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManage.cpp (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManage.h (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageMisc.cpp (modified) (1 diff)

trunk/doc/manual/Config.kmk

@@ -62 +62 @@
         man_VBoxManage-hostonlynet.xml \
         man_VBoxManage-updatecheck.xml \
-        man_VBoxManage-discardstate.xml
+        man_VBoxManage-discardstate.xml \
+        man_VBoxManage-adoptstate.xml
 
 ## List of user manual XML files.

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

@@ -20 +20 @@
 <refentry id="vboxmanage-adoptstate" lang="en">
   <refentryinfo>
-    <pubdate>August 2019</pubdate>
+    <pubdate>$Date$</pubdate>
     <title>VBoxManage adoptstate</title>
   </refentryinfo>
@@ -32 +32 @@
     <refname>VBoxManage-adoptstate</refname>
     <refpurpose>change a virtual machine's state based on a saved state file</refpurpose>
-    <refclass>Oracle VM VirtualBox</refclass>
+    <refclass>&product-name;</refclass>
   </refnamediv>
 
@@ -85 +85 @@
     <remark role="help-scope" condition="GLOBAL" />
     <para>
-      The following command starts a VM called <literal>vm2</literal>
-      using a saved state file called <filename>mystate.sav</filename>.
+      The following command adopts a saved state file called
+      <filename>mystate.sav</filename> by a VM called <literal>vm2</literal>.
+      A subsequent start of the VM called <literal>vm2</literal> restores the
+      state from the saved state file <filename>mystate.sav</filename>.
     </para>
 <screen>$ VBoxManage adoptstate vm2 /home/user/mystate.sav</screen>

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -339 +339 @@
   <xi:include href="user_man_VBoxManage-discardstate.xml"   xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
-  <sect1 id="vboxmanage-adoptstate">
-
-    <title>VBoxManage adoptstate</title>
-
-    <para>
-      If you have a Saved state file (<filename>.sav</filename>) that is
-      separate from the VM configuration, you can use this command to
-      <emphasis>adopt</emphasis> the file. This will change the VM to
-      saved state and when you start it, &product-name; will attempt to
-      restore it from the saved state file you indicated. This command
-      should only be used in special setups.
-    </para>
-
-  </sect1>
+  <xi:include href="user_man_VBoxManage-adoptstate.xml"     xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
   <xi:include href="user_man_VBoxManage-snapshot.xml"       xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />

trunk/src/VBox/Frontends/VBoxManage/VBoxManage.cpp

@@ -217 +217 @@
     { "unattended",         USAGE_S_NEWCMD,   HELP_CMD_UNATTENDED, handleUnattended,           0 },
     { "discardstate",       USAGE_S_NEWCMD, HELP_CMD_DISCARDSTATE, handleDiscardState,         0 },
-    { "adoptstate",         USAGE_ADOPTSTATE,       VBMG_CMD_TODO, handleAdoptState,           0 },
+    { "adoptstate",         USAGE_S_NEWCMD,   HELP_CMD_ADOPTSTATE, handleAdoptState,           0 },
     { "snapshot",           USAGE_S_NEWCMD,     HELP_CMD_SNAPSHOT, handleSnapshot,             0 },
     { "closemedium",        USAGE_CLOSEMEDIUM,      VBMG_CMD_TODO, handleCloseMedium,          0 },

trunk/src/VBox/Frontends/VBoxManage/VBoxManage.h

@@ -115 +115 @@
     USAGE_I_LISTPARTITIONS,
     USAGE_I_CREATERAWVMDK,
-    USAGE_ADOPTSTATE,
     USAGE_I_MODINSTALL,
     USAGE_I_MODUNINSTALL,

trunk/src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp

@@ -591 +591 @@
 
 #define SEP pcszSep1, pcszSep2
-
-    if (enmCommand == USAGE_ADOPTSTATE || enmCommand == USAGE_S_ALL)
-        RTStrmPrintf(pStrm,
-                           "%s adoptstate %s      <uuid|vmname> <state_file>\n"
-                     "\n", SEP);
 
     if (enmCommand == USAGE_CLOSEMEDIUM || enmCommand == USAGE_S_ALL)

trunk/src/VBox/Frontends/VBoxManage/VBoxManageMisc.cpp

@@ -789 +789 @@
 
     if (a->argc != 2)
-        return errorSyntax(USAGE_ADOPTSTATE, Misc::tr("Incorrect number of parameters"));
+        return errorSyntax(Misc::tr("Incorrect number of parameters"));
 
     ComPtr<IMachine> machine;