Changeset 94203 in vbox for trunk

Timestamp:

Mar 12, 2022 7:40:19 PM (3 years ago)

Author:

vboxsync

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

150459

Message:

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

Location:

trunk

Files:

• doc/manual/Config.kmk (modified) (1 diff)
• doc/manual/en_US/man_VBoxManage-convertfromraw.xml (modified) (2 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/VBoxManageDisk.cpp (modified) (2 diffs)
• src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp (modified) (1 diff)

trunk/doc/manual/Config.kmk

@@ -72 +72 @@
         man_VBoxManage-mediumproperty.xml \
         man_VBoxManage-encryptmedium.xml \
-        man_VBoxManage-checkmediumpwd.xml
+        man_VBoxManage-checkmediumpwd.xml \
+        man_VBoxManage-convertfromraw.xml
 
 ## List of user manual XML files.

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

@@ -20 +20 @@
 <refentry id="vboxmanage-convertfromraw" lang="en">
   <refentryinfo>
-    <pubdate>September 2019</pubdate>
+    <pubdate>$Date$</pubdate>
     <title>VBoxManage convertfromraw</title>
   </refentryinfo>
@@ -32 +32 @@
     <refname>VBoxManage-convertfromraw</refname>
     <refpurpose>convert a raw disk image to a virtual disk image</refpurpose>
-    <refclass>Oracle VM VirtualBox</refclass>
+    <refclass>&product-name;</refclass>
   </refnamediv>
 

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -1097 +1097 @@
   <xi:include href="user_man_VBoxManage-checkmediumpwd.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
-  <sect1 id="vboxmanage-convertfromraw">
-
-    <title>VBoxManage convertfromraw</title>
-
-    <para>
-      This command converts a raw disk image to an &product-name; Disk
-      Image (VDI) file. The syntax is as follows:
-    </para>
-
-<screen>VBoxManage convertfromraw   &lt;filename&gt; &lt;outputfile&gt;
-                            [--format VDI|VMDK|VHD]
-                            [--variant Standard,Fixed,Split2G,Stream,ESX]
-                            [--uuid &lt;uuid&gt;]
-VBoxManage convertfromraw   stdin &lt;outputfile&gt; &lt;bytes&gt;
-                            [--format VDI|VMDK|VHD]
-                            [--variant Standard,Fixed,Split2G,Stream,ESX]
-                            [--uuid &lt;uuid&gt;]</screen>
-
-    <para>
-      The parameters are as follows:
-    </para>
-
-    <variablelist>
-
-      <varlistentry>
-        <term>
-          <computeroutput>--bytes</computeroutput>
-        </term>
-
-        <listitem>
-          <para>
-            The size of the image file, in bytes, provided through
-            stdin.
-          </para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>
-          <computeroutput>--format</computeroutput>
-        </term>
-
-        <listitem>
-          <para>
-            Select the disk image format to create. The default format
-            is VDI. Other options are VMDK and VHD.
-          </para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>
-          <computeroutput>--variant</computeroutput>
-        </term>
-
-        <listitem>
-          <para>
-            Choose a file format variant for the output file. This is a
-            comma-separated list of variant flags. Not all combinations
-            are supported, and specifying inconsistent flags will result
-            in an error message.
-          </para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>
-          <computeroutput>--uuid</computeroutput>
-        </term>
-
-        <listitem>
-          <para>
-            Specify the UUID of the output file.
-          </para>
-        </listitem>
-      </varlistentry>
-
-    </variablelist>
-
-    <para>
-      The <command>stdin</command> form of the command forces
-      <command>VBoxManage</command> to read the content of the disk
-      image from standard input. This useful when using the command in a
-      pipe.
-    </para>
-
-    <note>
-      <para>
-        For compatibility with earlier versions of &product-name;, the
-        <command>convertdd</command> command is also supported and
-        mapped internally to the <command>convertfromraw</command>
-        command.
-      </para>
-    </note>
-
-  </sect1>
+  <xi:include href="user_man_VBoxManage-convertfromraw.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
   <xi:include href="user_man_VBoxManage-mediumio.xml"       xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />

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

@@ -254 +254 @@
     { "bandwidthctl",       USAGE_S_NEWCMD, HELP_CMD_BANDWIDTHCTL, handleBandwidthControl,     0 },
     { "debugvm",            USAGE_S_NEWCMD,      HELP_CMD_DEBUGVM, handleDebugVM,              0 },
-    { "convertfromraw",     USAGE_CONVERTFROMRAW,   VBMG_CMD_TODO, handleConvertFromRaw,       VBMG_CMD_F_NO_COM },
-    { "convertdd",          USAGE_CONVERTFROMRAW,   VBMG_CMD_TODO, handleConvertFromRaw,       VBMG_CMD_F_NO_COM },
+    { "convertfromraw",     USAGE_S_NEWCMD,HELP_CMD_CONVERTFROMRAW, handleConvertFromRaw,       VBMG_CMD_F_NO_COM },
+    { "convertdd",          USAGE_S_NEWCMD,HELP_CMD_CONVERTFROMRAW, handleConvertFromRaw,       VBMG_CMD_F_NO_COM },
     { "usbdevsource",       USAGE_USBDEVSOURCE,     VBMG_CMD_TODO, handleUSBDevSource,         0 },
     { "cloudprofile",       USAGE_S_NEWCMD,      HELP_CMD_CLOUDPROFILE, handleCloudProfile,         0 },

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

@@ -108 +108 @@
     USAGE_I_LOADMAP,
     USAGE_I_SETHDUUID,
-    USAGE_CONVERTFROMRAW,
     USAGE_I_LISTPARTITIONS,
     USAGE_I_CREATERAWVMDK,

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

@@ -1233 +1233 @@
             case 'u':   // --uuid
                 if (RT_FAILURE(RTUuidFromStr(&uuid, ValueUnion.psz)))
-                    return errorSyntax(USAGE_CONVERTFROMRAW, Disk::tr("Invalid UUID '%s'"), ValueUnion.psz);
+                    return errorSyntax(Disk::tr("Invalid UUID '%s'"), ValueUnion.psz);
                 pUuid = &uuid;
                 break;
@@ -1261 +1261 @@
                     filesize = ValueUnion.psz;
                 else
-                    return errorSyntax(USAGE_CONVERTFROMRAW, Disk::tr("Invalid parameter '%s'"), ValueUnion.psz);
+                    return errorSyntax(Disk::tr("Invalid parameter '%s'"), ValueUnion.psz);
                 break;
 
             default:
-                return errorGetOpt(USAGE_CONVERTFROMRAW, c, &ValueUnion);
+                return errorGetOpt(c, &ValueUnion);
         }
     }
 
     if (!srcfilename || !dstfilename || (fReadFromStdIn && !filesize))
-        return errorSyntax(USAGE_CONVERTFROMRAW, Disk::tr("Incorrect number of parameters"));
+        return errorSyntax(Disk::tr("Incorrect number of parameters"));
     RTStrmPrintf(g_pStdErr, Disk::tr("Converting from raw image file=\"%s\" to file=\"%s\"...\n"),
                  srcfilename, dstfilename);

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

@@ -639 +639 @@
                      "\n", SEP);
 
-    if (enmCommand == USAGE_CONVERTFROMRAW || enmCommand == USAGE_S_ALL)
-        RTStrmPrintf(pStrm,
-                           "%s convertfromraw %s  <filename> <outputfile>\n"
-                     "                            [--format VDI|VMDK|VHD]\n"
-                     "                            [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
-                     "                            [--uuid <uuid>]\n"
-                           "%s convertfromraw %s  stdin <outputfile> <bytes>\n"
-                     "                            [--format VDI|VMDK|VHD]\n"
-                     "                            [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
-                     "                            [--uuid <uuid>]\n"
-                     "\n", SEP, SEP);
-
     if (enmCommand == USAGE_GETEXTRADATA || enmCommand == USAGE_S_ALL)
         RTStrmPrintf(pStrm,