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

Timestamp:

Mar 13, 2022 7:48:18 PM (3 years ago)

Author:

vboxsync

Message:

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

Location:

trunk/src/VBox/Frontends/VBoxManage

Files:

• VBoxManage.cpp (modified) (1 diff)
• VBoxManage.h (modified) (2 diffs)
• VBoxManageGuestProp.cpp (modified) (13 diffs)
• VBoxManageHelp.cpp (modified) (1 diff)

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

@@ -232 +232 @@
     { "sharedfolder",       USAGE_S_NEWCMD, HELP_CMD_SHAREDFOLDER, handleSharedFolder,         0 },
 #ifdef VBOX_WITH_GUEST_PROPS
-    { "guestproperty",      USAGE_GUESTPROPERTY,    VBMG_CMD_TODO, handleGuestProperty,        0 },
+    { "guestproperty",      USAGE_S_NEWCMD,HELP_CMD_GUESTPROPERTY, handleGuestProperty,        0 },
 #endif
 #ifdef VBOX_WITH_GUEST_CONTROL

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

@@ -109 +109 @@
     USAGE_I_MODUNINSTALL,
     USAGE_I_RENAMEVMDK,
-#ifdef VBOX_WITH_GUEST_PROPS
-    USAGE_GUESTPROPERTY,
-#endif  /* VBOX_WITH_GUEST_PROPS defined */
     USAGE_I_CONVERTTORAW,
     USAGE_METRICS,
@@ -255 +252 @@
 RTEXITCODE handleDebugVM(HandlerArg *a);
 
-/* VBoxManageGuestProp.cpp */
-extern void usageGuestProperty(PRTSTREAM pStrm, const char *pcszSep1, const char *pcszSep2);
-
 /* VBoxManageGuestCtrl.cpp */
 extern void usageGuestControl(PRTSTREAM pStrm, const char *pcszSep1, const char *pcszSep2, uint64_t fSubcommandScope);

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

@@ -54 +54 @@
 
 
-void usageGuestProperty(PRTSTREAM pStrm, const char *pcszSep1, const char *pcszSep2)
-{
-    RTStrmPrintf(pStrm, "%s guestproperty %s   get <uuid|vmname>\n"
-                  "                            <property> [--verbose]\n"
-                  "\n", pcszSep1, pcszSep2);
-    RTStrmPrintf(pStrm, "%s guestproperty %s   set <uuid|vmname>\n"
-                  "                            <property> [<value> [--flags <flags>]]\n"
-                  "\n", pcszSep1, pcszSep2);
-    RTStrmPrintf(pStrm, "%s guestproperty %s   delete|unset <uuid|vmname>\n"
-                  "                            <property>\n"
-                  "\n", pcszSep1, pcszSep2);
-    RTStrmPrintf(pStrm, "%s guestproperty %s   enumerate <uuid|vmname>\n"
-                  "                            [--patterns <patterns>]\n"
-                  "\n", pcszSep1, pcszSep2);
-    RTStrmPrintf(pStrm, "%s guestproperty %s   wait <uuid|vmname> <patterns>\n"
-                  "                            [--timeout <msec>] [--fail-on-timeout]\n"
-                  "\n", pcszSep1, pcszSep2);
-}
-
 #ifndef VBOX_ONLY_DOCS
 
@@ -78 +59 @@
 {
     HRESULT rc = S_OK;
+
+    setCurrentSubcommand(HELP_SCOPE_GUESTPROPERTY_GET);
 
     bool verbose = false;
@@ -85 +68 @@
         verbose = true;
     else if (a->argc != 2)
-        return errorSyntax(USAGE_GUESTPROPERTY, GuestProp::tr("Incorrect parameters"));
+        return errorSyntax(GuestProp::tr("Incorrect parameters"));
 
     ComPtr<IMachine> machine;
@@ -121 +104 @@
     HRESULT rc = S_OK;
 
+    setCurrentSubcommand(HELP_SCOPE_GUESTPROPERTY_SET);
+
     /*
      * Check the syntax.  We can deduce the correct syntax from the number of
@@ -144 +129 @@
         usageOK = false;
     if (!usageOK)
-        return errorSyntax(USAGE_GUESTPROPERTY, GuestProp::tr("Incorrect parameters"));
+        return errorSyntax(GuestProp::tr("Incorrect parameters"));
     /* This is always needed. */
     pszName = a->argv[1];
@@ -179 +164 @@
     HRESULT rc = S_OK;
 
+    setCurrentSubcommand(HELP_SCOPE_GUESTPROPERTY_UNSET);
+
     /*
      * Check the syntax.  We can deduce the correct syntax from the number of
@@ -188 +175 @@
         usageOK = false;
     if (!usageOK)
-        return errorSyntax(USAGE_GUESTPROPERTY, GuestProp::tr("Incorrect parameters"));
+        return errorSyntax(GuestProp::tr("Incorrect parameters"));
     /* This is always needed. */
     pszName = a->argv[1];
@@ -221 +208 @@
 static RTEXITCODE handleEnumGuestProperty(HandlerArg *a)
 {
+    setCurrentSubcommand(HELP_SCOPE_GUESTPROPERTY_ENUMERATE);
+
     /*
      * Check the syntax.  We can deduce the correct syntax from the number of
@@ -230 +219 @@
              && strcmp(a->argv[1], "--patterns")
              && strcmp(a->argv[1], "-patterns")))
-        return errorSyntax(USAGE_GUESTPROPERTY, GuestProp::tr("Incorrect parameters"));
+        return errorSyntax(GuestProp::tr("Incorrect parameters"));
 
     /*
@@ -283 +272 @@
 static RTEXITCODE handleWaitGuestProperty(HandlerArg *a)
 {
+    setCurrentSubcommand(HELP_SCOPE_GUESTPROPERTY_WAIT);
+
     /*
      * Handle arguments
@@ -317 +308 @@
     }
     if (!usageOK)
-        return errorSyntax(USAGE_GUESTPROPERTY, GuestProp::tr("Incorrect parameters"));
+        return errorSyntax(GuestProp::tr("Incorrect parameters"));
 
     /*
@@ -420 +411 @@
 
     if (a->argc == 0)
-        return errorSyntax(USAGE_GUESTPROPERTY, GuestProp::tr("Incorrect parameters"));
+        return errorSyntax(GuestProp::tr("Incorrect parameters"));
 
     /* switch (cmd) */
@@ -435 +426 @@
 
     /* default: */
-    return errorSyntax(USAGE_GUESTPROPERTY, GuestProp::tr("Incorrect parameters"));
+    return errorSyntax(GuestProp::tr("Incorrect parameters"));
 }
 

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

@@ -639 +639 @@
                      "\n", SEP);
 
-#ifdef VBOX_WITH_GUEST_PROPS
-    if (enmCommand == USAGE_GUESTPROPERTY || enmCommand == USAGE_S_ALL)
-        usageGuestProperty(pStrm, SEP);
-#endif /* VBOX_WITH_GUEST_PROPS defined */
-
 #ifdef VBOX_WITH_GUEST_CONTROL
     if (enmCommand == USAGE_GUESTCONTROL || enmCommand == USAGE_S_ALL)