Changeset 94200 in vbox for trunk

Timestamp:

Mar 12, 2022 7:24:38 PM (3 years ago)

Author:

vboxsync

Message:

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

Location:

trunk

Files:

• doc/manual/Config.kmk (modified) (1 diff)
• doc/manual/en_US/man_VBoxManage-mediumproperty.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/VBoxManageDisk.cpp (modified) (3 diffs)
• src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp (modified) (1 diff)

trunk/doc/manual/Config.kmk

@@ -69 +69 @@
         man_VBoxManage-showmediuminfo.xml \
         man_VBoxManage-createmedium.xml \
-        man_VBoxManage-clonemedium.xml
+        man_VBoxManage-clonemedium.xml \
+        man_VBoxManage-mediumproperty.xml
 
 ## List of user manual XML files.

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

@@ -20 +20 @@
 <refentry id="vboxmanage-mediumproperty" lang="en">
   <refentryinfo>
-    <pubdate>September 2019</pubdate>
+    <pubdate>$Date$</pubdate>
     <title>VBoxManage mediumproperty</title>
   </refentryinfo>
@@ -32 +32 @@
     <refname>VBoxManage-mediumproperty</refname>
     <refpurpose>manage medium properties</refpurpose>
-    <refclass>Oracle VM VirtualBox</refclass>
+    <refclass>&product-name;</refclass>
   </refnamediv>
 

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -1091 +1091 @@
   <xi:include href="user_man_VBoxManage-clonemedium.xml"   xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
-  <sect1 id="vboxmanage-mediumproperty">
-
-    <title>VBoxManage mediumproperty</title>
-
-    <para>
-      This command sets, gets, or deletes a medium property. The syntax
-      is as follows:
-    </para>
-
-<screen>VBoxManage mediumproperty [disk|dvd|floppy] set &lt;uuid|filename&gt;
-                                                &lt;property&gt; &lt;value&gt;</screen>
-
-    <itemizedlist>
-
-      <listitem>
-        <para>
-          Use <computeroutput>&lt;disk|dvd|floppy&gt;</computeroutput>
-          to optionally specify the type of medium: disk (hard drive),
-          dvd, or floppy.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          Use <computeroutput>&lt;uuid|filename&gt;</computeroutput> to
-          supply either the UUID or absolute path of the medium or
-          image.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          Use <computeroutput>&lt;property&gt;</computeroutput> to
-          supply the name of the property.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          Use <computeroutput>&lt;value&gt;</computeroutput> to supply
-          the property value.
-        </para>
-      </listitem>
-
-    </itemizedlist>
-
-<screen>VBoxManage mediumproperty [disk|dvd|floppy] get &lt;uuid|filename&gt;
-                                                &lt;property&gt;</screen>
-
-    <itemizedlist>
-
-      <listitem>
-        <para>
-          Use <computeroutput>&lt;disk|dvd|floppy&gt;</computeroutput>
-          to optionally specify the type of medium: disk (hard drive),
-          dvd, or floppy.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          Use <computeroutput>&lt;uuid|filename&gt;</computeroutput> to
-          supply either the UUID or absolute path of the medium or
-          image.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          Use <computeroutput>&lt;property&gt;</computeroutput> to
-          supply the name of the property.
-        </para>
-      </listitem>
-
-    </itemizedlist>
-
-<screen>VBoxManage mediumproperty [disk|dvd|floppy] delete &lt;uuid|filename&gt;
-                                                   &lt;property&gt;</screen>
-
-    <itemizedlist>
-
-      <listitem>
-        <para>
-          Use <computeroutput>&lt;disk|dvd|floppy&gt;</computeroutput>
-          to optionally specify the type of medium: disk (hard drive),
-          dvd, or floppy.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          Use <computeroutput>&lt;uuid|filename&gt;</computeroutput> to
-          supply either the UUID or absolute path of the medium or
-          image.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          Use <computeroutput>&lt;property&gt;</computeroutput> to
-          supply the name of the property.
-        </para>
-      </listitem>
-
-    </itemizedlist>
-
-  </sect1>
+  <xi:include href="user_man_VBoxManage-mediumproperty.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
   <sect1 id="vboxmanage-encryptmedium">

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

@@ -198 +198 @@
     { "clonevm",            USAGE_S_NEWCMD,      HELP_CMD_CLONEVM, handleCloneVM,              0 },
     { "movevm",             USAGE_S_NEWCMD,       HELP_CMD_MOVEVM, handleMoveVM,               0 },
-    { "mediumproperty",     USAGE_MEDIUMPROPERTY,   VBMG_CMD_TODO, handleMediumProperty,       0 },
-    { "hdproperty",         USAGE_MEDIUMPROPERTY,   VBMG_CMD_TODO, handleMediumProperty,       0 }, /* backward compatibility */
+    { "mediumproperty",     USAGE_S_NEWCMD,HELP_CMD_MEDIUMPROPERTY, handleMediumProperty,       0 },
+    { "hdproperty",         USAGE_S_NEWCMD,HELP_CMD_MEDIUMPROPERTY, handleMediumProperty,       0 }, /* backward compatibility */
     { "createmedium",       USAGE_S_NEWCMD, HELP_CMD_CREATEMEDIUM, handleCreateMedium,         0 },
     { "createhd",           USAGE_S_NEWCMD, HELP_CMD_CREATEMEDIUM, handleCreateMedium,         0 }, /* backward compatibility */

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

@@ -132 +132 @@
     USAGE_I_REPAIRHD,
     USAGE_NATNETWORK,
-    USAGE_MEDIUMPROPERTY,
     USAGE_ENCRYPTMEDIUM,
     USAGE_MEDIUMENCCHKPWD,

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

@@ -1897 +1897 @@
 
     if (a->argc == 0)
-        return errorSyntax(USAGE_MEDIUMPROPERTY, Disk::tr("Missing action"));
+        return errorSyntax(Disk::tr("Missing action"));
 
     pszAction = a->argv[0];
@@ -1903 +1903 @@
         && RTStrICmp(pszAction, "get")
         && RTStrICmp(pszAction, "delete"))
-        return errorSyntax(USAGE_MEDIUMPROPERTY, Disk::tr("Invalid action given: %s"), pszAction);
+        return errorSyntax(Disk::tr("Invalid action given: %s"), pszAction);
 
     if (   (   !RTStrICmp(pszAction, "set")
@@ -1909 +1909 @@
         || (   RTStrICmp(pszAction, "set")
             && a->argc != 3))
-        return errorSyntax(USAGE_MEDIUMPROPERTY, Disk::tr("Invalid number of arguments given for action: %s"), pszAction);
+        return errorSyntax(Disk::tr("Invalid number of arguments given for action: %s"), pszAction);
 
     pszFilenameOrUuid = a->argv[1];

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

@@ -639 +639 @@
                      "\n", SEP);
 
-    if (enmCommand == USAGE_MEDIUMPROPERTY || enmCommand == USAGE_S_ALL)
-        RTStrmPrintf(pStrm,
-                           "%s mediumproperty %s  [disk|dvd|floppy] set <uuid|filename>\n"
-                     "                            <property> <value>\n"
-                     "\n"
-                     "                            [disk|dvd|floppy] get <uuid|filename>\n"
-                     "                            <property>\n"
-                     "\n"
-                     "                            [disk|dvd|floppy] delete <uuid|filename>\n"
-                     "                            <property>\n"
-                     "\n", SEP);
-
     if (enmCommand == USAGE_ENCRYPTMEDIUM || enmCommand == USAGE_S_ALL)
         RTStrmPrintf(pStrm,