Changeset 77801 in vbox for trunk/src/VBox/Frontends/VBoxManage

Timestamp:

Mar 19, 2019 5:44:40 PM (6 years ago)

Author:

vboxsync

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

129468

Message:

VBoxManage snapshot: Use manpage help text (option parsing needs cleaning up!).

Location:

trunk/src/VBox/Frontends/VBoxManage

Files:

• VBoxManage.cpp (modified) (1 diff)
• VBoxManage.h (modified) (1 diff)
• VBoxManageHelp.cpp (modified) (1 diff)
• VBoxManageSnapshot.cpp (modified) (10 diffs)

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

@@ -125 +125 @@
     { "discardstate",       USAGE_DISCARDSTATE,     VBMG_CMD_TODO, handleDiscardState,         0 },
     { "adoptstate",         USAGE_ADOPTSTATE,       VBMG_CMD_TODO, handleAdoptState,           0 },
-    { "snapshot",           USAGE_SNAPSHOT,         VBMG_CMD_TODO, handleSnapshot,             0 },
+    { "snapshot",           USAGE_S_NEWCMD,     HELP_CMD_SNAPSHOT, handleSnapshot,             0 },
     { "closemedium",        USAGE_CLOSEMEDIUM,      VBMG_CMD_TODO, handleCloseMedium,          0 },
     { "storageattach",      USAGE_STORAGEATTACH,    VBMG_CMD_TODO, handleStorageAttach,        0 },

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

@@ -61 +61 @@
     USAGE_CONTROLVM,
     USAGE_DISCARDSTATE,
-    USAGE_SNAPSHOT,
     USAGE_CLOSEMEDIUM,
     USAGE_SHOWMEDIUMINFO,

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

@@ -898 +898 @@
                      "\n", SEP);
 
-    if (enmCommand == USAGE_SNAPSHOT || enmCommand == USAGE_S_ALL)
-        RTStrmPrintf(pStrm,
-                           "%s snapshot %s        <uuid|vmname>\n"
-                     "                            take <name> [--description <desc>] [--live]\n"
-                     "                                 [--uniquename Number,Timestamp,Space,Force] |\n"
-                     "                            delete <uuid|snapname> |\n"
-                     "                            restore <uuid|snapname> |\n"
-                     "                            restorecurrent |\n"
-                     "                            edit <uuid|snapname>|--current\n"
-                     "                                 [--name <name>]\n"
-                     "                                 [--description <desc>] |\n"
-                     "                            list [--details|--machinereadable] |\n"
-                     "                            showvminfo <uuid|snapname>\n"
-                     "\n", SEP);
-
     if (enmCommand == USAGE_CLOSEMEDIUM || enmCommand == USAGE_S_ALL)
         RTStrmPrintf(pStrm,

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

@@ -186 +186 @@
             case 'D':   enmDetails = VMINFO_FULL; break;
             case 'M':   enmDetails = VMINFO_MACHINEREADABLE; break;
-            default:    return errorGetOpt(USAGE_SNAPSHOT, c, &ValueUnion);
+            default:    return errorGetOpt(c, &ValueUnion);
         }
     }
@@ -316 +316 @@
     HRESULT rc;
 
+/** @todo r=bird: sub-standard command line parsing here!
+ *
+ * 'VBoxManage snapshot empty take --help' takes a snapshot rather than display
+ * help as you would expect.
+ *
+ */
+
     /* we need at least a VM and a command */
     if (a->argc < 2)
-        return errorSyntax(USAGE_SNAPSHOT, "Not enough parameters");
+        return errorSyntax("Not enough parameters");
 
     /* the first argument must be the VM */
@@ -343 +350 @@
         if (!strcmp(a->argv[1], "take"))
         {
+            setCurrentSubcommand(HELP_SCOPE_SNAPSHOT_TAKE);
+
             /* there must be a name */
             if (a->argc < 3)
             {
-                errorSyntax(USAGE_SNAPSHOT, "Missing snapshot name");
+                errorSyntax("Missing snapshot name");
                 rc = E_FAIL;
                 break;
@@ -395 +404 @@
 
                     default:
-                        errorGetOpt(USAGE_SNAPSHOT, ch, &Value);
+                        errorGetOpt(ch, &Value);
                         rc = E_FAIL;
                         break;
@@ -479 +488 @@
                 )
         {
+            setCurrentSubcommand(fDelete    ? HELP_SCOPE_SNAPSHOT_DELETE
+                                 : fRestore ? HELP_SCOPE_SNAPSHOT_RESTORE
+                                            : HELP_SCOPE_SNAPSHOT_RESTORECURRENT);
+
             if (fRestoreCurrent)
             {
                 if (a->argc > 2)
                 {
-                    errorSyntax(USAGE_SNAPSHOT, "Too many arguments");
+                    errorSyntax("Too many arguments");
                     rc = E_FAIL;
                     break;
@@ -491 +504 @@
             else if (a->argc != 3)
             {
-                errorSyntax(USAGE_SNAPSHOT, "Expecting snapshot name only");
+                errorSyntax("Expecting snapshot name only");
                 rc = E_FAIL;
                 break;
@@ -541 +554 @@
         else if (!strcmp(a->argv[1], "edit"))
         {
+            setCurrentSubcommand(HELP_SCOPE_SNAPSHOT_EDIT);
             if (a->argc < 3)
             {
-                errorSyntax(USAGE_SNAPSHOT, "Missing snapshot name");
+                errorSyntax("Missing snapshot name");
                 rc = E_FAIL;
                 break;
@@ -597 +611 @@
                 else
                 {
-                    errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(a->argv[i]).c_str());
+                    errorSyntax("Invalid parameter '%s'", Utf8Str(a->argv[i]).c_str());
                     rc = E_FAIL;
                     break;
@@ -606 +620 @@
         else if (!strcmp(a->argv[1], "showvminfo"))
         {
+            setCurrentSubcommand(HELP_SCOPE_SNAPSHOT_SHOWVMINFO);
+
             /* exactly one parameter: snapshot name */
             if (a->argc != 3)
             {
-                errorSyntax(USAGE_SNAPSHOT, "Expecting snapshot name only");
+                errorSyntax("Expecting snapshot name only");
                 rc = E_FAIL;
                 break;
@@ -625 +641 @@
         }
         else if (!strcmp(a->argv[1], "list"))
+        {
+            setCurrentSubcommand(HELP_SCOPE_SNAPSHOT_LIST);
             rc = handleSnapshotList(a, sessionMachine) == RTEXITCODE_SUCCESS ? S_OK : E_FAIL;
+        }
         else if (!strcmp(a->argv[1], "dump"))          // undocumented parameter to debug snapshot info
             DumpSnapshot(sessionMachine);
         else
         {
-            errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(a->argv[1]).c_str());
+            errorSyntax("Invalid parameter '%s'", Utf8Str(a->argv[1]).c_str());
             rc = E_FAIL;
         }