Changeset 94204 in vbox for trunk

Timestamp:

Mar 12, 2022 7:57:40 PM (3 years ago)

Author:

vboxsync

Message:

doc/manual,FE/VBoxManage: Convert setextradata/getextradata commands to refentry documentation, ​bugref:9186

Location:

trunk

Files:

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

trunk/doc/manual/Config.kmk

@@ -73 +73 @@
         man_VBoxManage-encryptmedium.xml \
         man_VBoxManage-checkmediumpwd.xml \
-        man_VBoxManage-convertfromraw.xml
+        man_VBoxManage-convertfromraw.xml \
+        man_VBoxManage-setextradata.xml \
+        man_VBoxManage-getextradata.xml
 
 ## List of user manual XML files.

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

@@ -33 +33 @@
     <refpurpose>view keyword values that are associated with a virtual machine or
       configuration</refpurpose>
-    <refclass>Oracle VM VirtualBox</refclass>
+    <refclass>&product-name;</refclass>
   </refnamediv>
 

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

@@ -20 +20 @@
 <refentry id="vboxmanage-setextradata" lang="en">
   <refentryinfo>
-    <pubdate>August 2019</pubdate>
+    <pubdate>$Date$</pubdate>
     <title>VBoxManage setextradata</title>
   </refentryinfo>
@@ -33 +33 @@
     <refpurpose>set a keyword value that is associated with a virtual machine or
       configuration</refpurpose>
-    <refclass>Oracle VM VirtualBox</refclass>
+    <refclass>&product-name;</refclass>
   </refnamediv>
 

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -1101 +1101 @@
   <xi:include href="user_man_VBoxManage-mediumio.xml"       xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
-  <sect1 id="vboxmanage-extradata">
-
-    <title>VBoxManage getextradata/setextradata</title>
-
-    <para>
-      These commands enable you to attach and retrieve string data for a
-      virtual machine or for an &product-name; configuration, by
-      specifying <computeroutput>global</computeroutput> instead of a
-      virtual machine name. You must specify a keyword as a text string
-      to associate the data with, which you can later use to retrieve
-      it. For example:
-    </para>
-
-<screen>VBoxManage setextradata Fedora5 installdate 2006.01.01
-VBoxManage setextradata SUSE10 installdate 2006.02.02</screen>
-
-    <para>
-      This example would associate the string "2006.01.01" with the
-      keyword installdate for the virtual machine Fedora5, and
-      "2006.02.02" on the machine SUSE10. You could then retrieve the
-      information as follows:
-    </para>
-
-<screen>VBoxManage getextradata Fedora5 installdate</screen>
-
-    <para>
-      This would return the following:
-    </para>
-
-<screen>VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable>
-(C) 2005-2018 Oracle Corporation
-All rights reserved.
-
-Value: 2006.01.01</screen>
-
-    <para>
-      You could retrieve the information for all keywords as follows:
-    </para>
-
-<screen>VBoxManage getextradata Fedora5 enumerate</screen>
-
-    <para>
-      To remove a keyword, the <command>setextradata</command> command
-      must be run without specifying data, only the keyword. For
-      example:
-    </para>
-
-<screen>VBoxManage setextradata Fedora5 installdate</screen>
-
-  </sect1>
+  <xi:include href="user_man_VBoxManage-setextradata.xml"   xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+  <xi:include href="user_man_VBoxManage-getextradata.xml"   xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
   <sect1 id="vboxmanage-setproperty">

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

@@ -226 +226 @@
     { "showvdiinfo",        USAGE_S_NEWCMD,HELP_CMD_SHOWMEDIUMINFO, handleShowMediumInfo,       0 }, /* backward compatibility */
     { "mediumio",           USAGE_S_NEWCMD,     HELP_CMD_MEDIUMIO, handleMediumIO,             0 },
-    { "getextradata",       USAGE_GETEXTRADATA,     VBMG_CMD_TODO, handleGetExtraData,         0 },
-    { "setextradata",       USAGE_SETEXTRADATA,     VBMG_CMD_TODO, handleSetExtraData,         0 },
+    { "getextradata",       USAGE_S_NEWCMD, HELP_CMD_GETEXTRADATA, handleGetExtraData,         0 },
+    { "setextradata",       USAGE_S_NEWCMD, HELP_CMD_SETEXTRADATA, handleSetExtraData,         0 },
     { "setproperty",        USAGE_SETPROPERTY,      VBMG_CMD_TODO, handleSetProperty,          0 },
     { "usbfilter",          USAGE_USBFILTER,        VBMG_CMD_TODO, handleUSBFilter,            0 },

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

@@ -101 +101 @@
     USAGE_CREATEHOSTIF,
     USAGE_REMOVEHOSTIF,
-    USAGE_GETEXTRADATA,
-    USAGE_SETEXTRADATA,
     USAGE_SETPROPERTY,
     USAGE_USBFILTER,

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

@@ -639 +639 @@
                      "\n", SEP);
 
-    if (enmCommand == USAGE_GETEXTRADATA || enmCommand == USAGE_S_ALL)
-        RTStrmPrintf(pStrm,
-                           "%s getextradata %s    global|<uuid|vmname>\n"
-                     "                            <key>|[enumerate]\n"
-                     "\n", SEP);
-
-    if (enmCommand == USAGE_SETEXTRADATA || enmCommand == USAGE_S_ALL)
-        RTStrmPrintf(pStrm,
-                           "%s setextradata %s    global|<uuid|vmname>\n"
-                     "                            <key>\n"
-                     "                            [<value>] (no value deletes key)\n"
-                     "\n", SEP);
-
     if (enmCommand == USAGE_SETPROPERTY || enmCommand == USAGE_S_ALL)
     {

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

@@ -824 +824 @@
 
     if (a->argc > 2 || a->argc < 1)
-        return errorSyntax(USAGE_GETEXTRADATA, Misc::tr("Incorrect number of parameters"));
+        return errorSyntax(Misc::tr("Incorrect number of parameters"));
 
     /* global data? */
@@ -903 +903 @@
 
     if (a->argc < 2)
-        return errorSyntax(USAGE_SETEXTRADATA, Misc::tr("Not enough parameters"));
+        return errorSyntax(Misc::tr("Not enough parameters"));
 
     /* global data? */
@@ -916 +916 @@
                                                     Bstr(a->argv[2]).raw()));
         else
-            return errorSyntax(USAGE_SETEXTRADATA, Misc::tr("Too many parameters"));
+            return errorSyntax(Misc::tr("Too many parameters"));
     }
     else
@@ -938 +938 @@
                                                          Bstr(a->argv[2]).raw()));
             else
-                return errorSyntax(USAGE_SETEXTRADATA, Misc::tr("Too many parameters"));
+                return errorSyntax(Misc::tr("Too many parameters"));
         }
     }