Changeset 94218 in vbox for trunk/src/VBox

Timestamp:

Mar 14, 2022 9:02:16 AM (3 years ago)

Author:

vboxsync

Message:

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

Location:

trunk/src/VBox/Frontends/VBoxManage

Files:

• VBoxManage.cpp (modified) (1 diff)
• VBoxManage.h (modified) (1 diff)
• VBoxManageDisk.cpp (modified) (7 diffs)
• VBoxManageHelp.cpp (modified) (1 diff)

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

@@ -203 +203 @@
     { "createhd",           USAGE_S_NEWCMD, HELP_CMD_CREATEMEDIUM, handleCreateMedium,         0 }, /* backward compatibility */
     { "createvdi",          USAGE_S_NEWCMD, HELP_CMD_CREATEMEDIUM, handleCreateMedium,         0 }, /* backward compatibility */
-    { "modifymedium",       USAGE_MODIFYMEDIUM,     VBMG_CMD_TODO, handleModifyMedium,         0 },
-    { "modifyhd",           USAGE_MODIFYMEDIUM,     VBMG_CMD_TODO, handleModifyMedium,         0 }, /* backward compatibility */
-    { "modifyvdi",          USAGE_MODIFYMEDIUM,     VBMG_CMD_TODO, handleModifyMedium,         0 }, /* backward compatibility */
+    { "modifymedium",       USAGE_S_NEWCMD, HELP_CMD_MODIFYMEDIUM, handleModifyMedium,         0 },
+    { "modifyhd",           USAGE_S_NEWCMD, HELP_CMD_MODIFYMEDIUM, handleModifyMedium,         0 }, /* backward compatibility */
+    { "modifyvdi",          USAGE_S_NEWCMD, HELP_CMD_MODIFYMEDIUM, handleModifyMedium,         0 }, /* backward compatibility */
     { "clonemedium",        USAGE_S_NEWCMD,  HELP_CMD_CLONEMEDIUM, handleCloneMedium,          0 },
     { "clonehd",            USAGE_S_NEWCMD,  HELP_CMD_CLONEMEDIUM, handleCloneMedium,          0 }, /* backward compatibility */

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

@@ -98 +98 @@
 {
     USAGE_INVALID = 0,
-    USAGE_MODIFYMEDIUM,
     USAGE_CREATEHOSTIF,
     USAGE_REMOVEHOSTIF,

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

@@ -699 +699 @@
             case 'H':   // disk
                 if (cmd != CMD_NONE)
-                    return errorSyntax(USAGE_MODIFYMEDIUM, 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;
@@ -705 +705 @@
             case 'D':   // DVD
                 if (cmd != CMD_NONE)
-                    return errorSyntax(USAGE_MODIFYMEDIUM, 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;
@@ -711 +711 @@
             case 'L':   // floppy
                 if (cmd != CMD_NONE)
-                    return errorSyntax(USAGE_MODIFYMEDIUM, 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;
@@ -799 +799 @@
                     pszFilenameOrUuid = ValueUnion.psz;
                 else
-                    return errorSyntax(USAGE_MODIFYMEDIUM, Disk::tr("Invalid parameter '%s'"), ValueUnion.psz);
+                    return errorSyntax(Disk::tr("Invalid parameter '%s'"), ValueUnion.psz);
                 break;
 
@@ -806 +806 @@
                 {
                     if (RT_C_IS_PRINT(c))
-                        return errorSyntax(USAGE_MODIFYMEDIUM, Disk::tr("Invalid option -%c"), c);
+                        return errorSyntax(Disk::tr("Invalid option -%c"), c);
                     else
-                        return errorSyntax(USAGE_MODIFYMEDIUM, 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_MODIFYMEDIUM, 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_MODIFYMEDIUM, "%s: %Rrs", ValueUnion.pDef->pszLong, c);
+                    return errorSyntax("%s: %Rrs", ValueUnion.pDef->pszLong, c);
                 else
-                    return errorSyntax(USAGE_MODIFYMEDIUM, Disk::tr("error: %Rrs"), c);
+                    return errorSyntax(Disk::tr("error: %Rrs"), c);
         }
     }
@@ -823 +823 @@
 
     if (!pszFilenameOrUuid)
-        return errorSyntax(USAGE_MODIFYMEDIUM, Disk::tr("Medium name or UUID required"));
+        return errorSyntax(Disk::tr("Medium name or UUID required"));
 
     if (!fModifyMediumType
@@ -834 +834 @@
         && !fModifyDescription
         )
-        return errorSyntax(USAGE_MODIFYMEDIUM, Disk::tr("No operation specified"));
+        return errorSyntax(Disk::tr("No operation specified"));
 
     /* Always open the medium if necessary, there is no other way. */

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

@@ -584 +584 @@
                      "\n");
 
-    const char *pcszSep1 = " ";
-    const char *pcszSep2 = "         ";
-    if (enmCommand != USAGE_S_ALL)
-    {
-        pcszSep1 = "VBoxManage";
-        pcszSep2 = "";
-    }
-
-#define SEP pcszSep1, pcszSep2
-
-    if (enmCommand == USAGE_MODIFYMEDIUM || enmCommand == USAGE_S_ALL)
-        RTStrmPrintf(pStrm,
-                           "%s modifymedium %s    [disk|dvd|floppy] <uuid|filename>\n"
-                     "                            [--type normal|writethrough|immutable|shareable|\n"
-                     "                                    readonly|multiattach]\n"
-                     "                            [--autoreset on|off]\n"
-                     "                            [--property <name=[value]>]\n"
-                     "                            [--compact]\n"
-                     "                            [--resize <megabytes>|--resizebyte <bytes>]\n"
-                     "                            [--move <path>]\n"
-                     "                            [--setlocation <path>]\n"
-                     "                            [--description <description string>]"
-                     "\n", SEP);
-
 #ifndef VBOX_ONLY_DOCS /* Converted to man page, not needed. */
     if (enmCommand == USAGE_S_ALL)