Changeset 94181 in vbox for trunk/src/VBox/Frontends

Timestamp:

Mar 11, 2022 4:55:03 PM (3 years ago)

Author:

vboxsync

Message:

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

Location:

trunk/src/VBox/Frontends/VBoxManage

Files:

• VBoxManage.cpp (modified) (1 diff)
• VBoxManage.h (modified) (1 diff)
• VBoxManageBandwidthControl.cpp (modified) (9 diffs)
• VBoxManageHelp.cpp (modified) (1 diff)

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

@@ -252 +252 @@
 #endif
     { "extpack",            USAGE_S_NEWCMD,      HELP_CMD_EXTPACK, handleExtPack,              0 },
-    { "bandwidthctl",       USAGE_BANDWIDTHCONTROL, VBMG_CMD_TODO, handleBandwidthControl,     0 },
+    { "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 },

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

@@ -132 +132 @@
     USAGE_I_SETHDPARENTUUID,
     USAGE_I_PASSWORDHASH,
-    USAGE_BANDWIDTHCONTROL,
     USAGE_I_GUESTSTATS,
     USAGE_I_REPAIRHD,

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

@@ -109 +109 @@
         };
 
+    setCurrentSubcommand(HELP_SCOPE_BANDWIDTHCTL_ADD);
 
     Bstr name(a->argv[2]);
@@ -158 +159 @@
             default:
             {
-                errorGetOpt(USAGE_BANDWIDTHCONTROL, c, &ValueUnion);
+                errorGetOpt(c, &ValueUnion);
                 rc = E_FAIL;
                 break;
@@ -196 +197 @@
         };
 
+    setCurrentSubcommand(HELP_SCOPE_BANDWIDTHCTL_SET);
 
     Bstr name(a->argv[2]);
@@ -229 +231 @@
             default:
             {
-                errorGetOpt(USAGE_BANDWIDTHCONTROL, c, &ValueUnion);
+                errorGetOpt(c, &ValueUnion);
                 rc = E_FAIL;
                 break;
@@ -258 +260 @@
 static RTEXITCODE handleBandwidthControlRemove(HandlerArg *a, ComPtr<IBandwidthControl> &bwCtrl)
 {
+    setCurrentSubcommand(HELP_SCOPE_BANDWIDTHCTL_REMOVE);
+
     Bstr name(a->argv[2]);
     CHECK_ERROR2I_RET(bwCtrl, DeleteBandwidthGroup(name.raw()), RTEXITCODE_FAILURE);
@@ -276 +280 @@
     };
 
+    setCurrentSubcommand(HELP_SCOPE_BANDWIDTHCTL_LIST);
     VMINFO_DETAILS enmDetails = VMINFO_STANDARD;
 
@@ -290 +295 @@
                 break;
             default:
-                return errorGetOpt(USAGE_BANDWIDTHCONTROL, c, &ValueUnion);
+                return errorGetOpt(c, &ValueUnion);
         }
     }
@@ -313 +318 @@
 
     if (a->argc < 2)
-        return errorSyntax(USAGE_BANDWIDTHCONTROL, BWControl::tr("Too few parameters"));
+        return errorSyntax(BWControl::tr("Too few parameters"));
     else if (a->argc > 7)
-        return errorSyntax(USAGE_BANDWIDTHCONTROL, BWControl::tr("Too many parameters"));
+        return errorSyntax(BWControl::tr("Too many parameters"));
 
     /* try to find the given machine */
@@ -356 +361 @@
     else
     {
-        errorSyntax(USAGE_BANDWIDTHCONTROL, BWControl::tr("Invalid parameter '%s'"), a->argv[1]);
+        errorSyntax(BWControl::tr("Invalid parameter '%s'"), a->argv[1]);
         rc = E_FAIL;
     }

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

@@ -625 +625 @@
                      "\n", SEP);
 
-    if (enmCommand == USAGE_BANDWIDTHCONTROL || enmCommand == USAGE_S_ALL)
-        RTStrmPrintf(pStrm,
-                           "%s bandwidthctl %s    <uuid|vmname>\n"
-                     "                            add <name> --type disk|network\n"
-                     "                                --limit <megabytes per second>[k|m|g|K|M|G] |\n"
-                     "                            set <name>\n"
-                     "                                --limit <megabytes per second>[k|m|g|K|M|G] |\n"
-                     "                            remove <name> |\n"
-                     "                            list [--machinereadable]\n"
-                     "                            (limit units: k=kilobit, m=megabit, g=gigabit,\n"
-                     "                                          K=kilobyte, M=megabyte, G=gigabyte)\n"
-                     "\n", SEP);
-
     if (enmCommand == USAGE_SHOWMEDIUMINFO || enmCommand == USAGE_S_ALL)
         RTStrmPrintf(pStrm,