Changeset 94177 in vbox for trunk

Timestamp:

Mar 11, 2022 3:26:05 PM (3 years ago)

Author:

vboxsync

Message:

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

Location:

trunk

Files:

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

trunk/doc/manual/Config.kmk

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

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

@@ -20 +20 @@
 <refentry id="vboxmanage-closemedium" lang="en">
   <refentryinfo>
-    <pubdate>August 2019</pubdate>
+    <pubdate>$Date$</pubdate>
     <title>VBoxManage closemedium</title>
   </refentryinfo>
@@ -32 +32 @@
     <refname>VBoxManage-closemedium</refname>
     <refpurpose>remove a hard disk, DVD, or floppy image from the media registry</refpurpose>
-    <refclass>Oracle VM VirtualBox</refclass>
+    <refclass>&product-name;</refclass>
   </refnamediv>
 

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -343 +343 @@
   <xi:include href="user_man_VBoxManage-snapshot.xml"       xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
-  <sect1 id="vboxmanage-closemedium">
-
-    <title>VBoxManage closemedium</title>
-
-    <para>
-      This command removes a hard disk, DVD, or floppy image from a
-      &product-name; media registry.
-    </para>
-
-<screen>VBoxManage closemedium      [disk|dvd|floppy] &lt;uuid|filename&gt;
-                            [--delete]</screen>
-
-    <para>
-      Optionally, you can request that the image be deleted. You will
-      get appropriate diagnostics that the deletion failed, however the
-      image will become unregistered in any case.
-    </para>
-
-  </sect1>
+  <xi:include href="user_man_VBoxManage-closemedium.xml"    xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
   <sect1 id="vboxmanage-storageattach">

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

@@ -219 +219 @@
     { "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 },
+    { "closemedium",        USAGE_S_NEWCMD,  HELP_CMD_CLOSEMEDIUM, handleCloseMedium,          0 },
     { "storageattach",      USAGE_STORAGEATTACH,    VBMG_CMD_TODO, handleStorageAttach,        0 },
     { "storagectl",         USAGE_STORAGECONTROLLER,VBMG_CMD_TODO, handleStorageController,    0 },

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

@@ -98 +98 @@
 {
     USAGE_INVALID = 0,
-    USAGE_CLOSEMEDIUM,
     USAGE_SHOWMEDIUMINFO,
     USAGE_CREATEMEDIUM,

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

@@ -1772 +1772 @@
             case 'd':   // disk
                 if (cmd != CMD_NONE)
-                    return errorSyntax(USAGE_CLOSEMEDIUM, Disk::tr("Only one command can be specified: '%s'"), ValueUnion.psz);
+                    return errorSyntax(Disk::tr("Only one command can be specified: '%s'"), ValueUnion.psz);
                 cmd = CMD_DISK;
                 break;
@@ -1778 +1778 @@
             case 'D':   // DVD
                 if (cmd != CMD_NONE)
-                    return errorSyntax(USAGE_CLOSEMEDIUM, Disk::tr("Only one command can be specified: '%s'"), ValueUnion.psz);
+                    return errorSyntax(Disk::tr("Only one command can be specified: '%s'"), ValueUnion.psz);
                 cmd = CMD_DVD;
                 break;
@@ -1784 +1784 @@
             case 'f':   // floppy
                 if (cmd != CMD_NONE)
-                    return errorSyntax(USAGE_CLOSEMEDIUM, Disk::tr("Only one command can be specified: '%s'"), ValueUnion.psz);
+                    return errorSyntax(Disk::tr("Only one command can be specified: '%s'"), ValueUnion.psz);
                 cmd = CMD_FLOPPY;
                 break;
@@ -1796 +1796 @@
                     pszFilenameOrUuid = ValueUnion.psz;
                 else
-                    return errorSyntax(USAGE_CLOSEMEDIUM, Disk::tr("Invalid parameter '%s'"), ValueUnion.psz);
+                    return errorSyntax(Disk::tr("Invalid parameter '%s'"), ValueUnion.psz);
                 break;
 
@@ -1803 +1803 @@
                 {
                     if (RT_C_IS_PRINT(c))
-                        return errorSyntax(USAGE_CLOSEMEDIUM, Disk::tr("Invalid option -%c"), c);
+                        return errorSyntax(Disk::tr("Invalid option -%c"), c);
                     else
-                        return errorSyntax(USAGE_CLOSEMEDIUM, Disk::tr("Invalid option case %i"), c);
+                        return errorSyntax(Disk::tr("Invalid option case %i"), c);
                 }
                 else if (c == VERR_GETOPT_UNKNOWN_OPTION)
-                    return errorSyntax(USAGE_CLOSEMEDIUM, Disk::tr("unknown option: %s\n"), ValueUnion.psz);
+                    return errorSyntax(Disk::tr("unknown option: %s\n"), ValueUnion.psz);
                 else if (ValueUnion.pDef)
-                    return errorSyntax(USAGE_CLOSEMEDIUM, "%s: %Rrs", ValueUnion.pDef->pszLong, c);
+                    return errorSyntax("%s: %Rrs", ValueUnion.pDef->pszLong, c);
                 else
-                    return errorSyntax(USAGE_CLOSEMEDIUM, Disk::tr("error: %Rrs"), c);
+                    return errorSyntax(Disk::tr("error: %Rrs"), c);
         }
     }
@@ -1820 +1820 @@
         cmd = CMD_DISK;
     if (!pszFilenameOrUuid)
-        return errorSyntax(USAGE_CLOSEMEDIUM, Disk::tr("Medium name or UUID required"));
+        return errorSyntax(Disk::tr("Medium name or UUID required"));
 
     ComPtr<IMedium> pMedium;

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

@@ -591 +591 @@
 
 #define SEP pcszSep1, pcszSep2
-
-    if (enmCommand == USAGE_CLOSEMEDIUM || enmCommand == USAGE_S_ALL)
-        RTStrmPrintf(pStrm,
-                           "%s closemedium %s     [disk|dvd|floppy] <uuid|filename>\n"
-                     "                            [--delete]\n"
-                     "\n", SEP);
 
     if (enmCommand == USAGE_STORAGEATTACH || enmCommand == USAGE_S_ALL)