Changeset 94179 in vbox

Timestamp:

Mar 11, 2022 4:43:01 PM (3 years ago)

Author:

vboxsync

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

150435

Message:

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

Location:

trunk

Files:

• doc/manual/Config.kmk (modified) (1 diff)
• doc/manual/en_US/man_VBoxManage-storagectl.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/VBoxManageStorageController.cpp (modified) (3 diffs)

trunk/doc/manual/Config.kmk

@@ -64 +64 @@
         man_VBoxManage-discardstate.xml \
         man_VBoxManage-adoptstate.xml \
-        man_VBoxManage-closemedium.xml
+        man_VBoxManage-closemedium.xml \
+        man_VBoxManage-storagectl.xml
 
 ## List of user manual XML files.

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

@@ -20 +20 @@
 <refentry id="vboxmanage-storagectl" lang="en">
   <refentryinfo>
-    <pubdate>August 2019</pubdate>
+    <pubdate>$Date$</pubdate>
     <title>VBoxManage storagectl</title>
   </refentryinfo>
@@ -32 +32 @@
     <refname>VBoxManage-storagectl</refname>
     <refpurpose>manage a storage controller</refpurpose>
-    <refclass>Oracle VM VirtualBox</refclass>
+    <refclass>&product-name;</refclass>
   </refnamediv>
 

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -925 +925 @@
   </sect1>
 
+  <xi:include href="user_man_VBoxManage-storagectl.xml"    xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
   <sect1 id="vboxmanage-storagectl">
 

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

@@ -221 +221 @@
     { "closemedium",        USAGE_S_NEWCMD,  HELP_CMD_CLOSEMEDIUM, handleCloseMedium,          0 },
     { "storageattach",      USAGE_STORAGEATTACH,    VBMG_CMD_TODO, handleStorageAttach,        0 },
-    { "storagectl",         USAGE_STORAGECONTROLLER,VBMG_CMD_TODO, handleStorageController,    0 },
+    { "storagectl",         USAGE_S_NEWCMD,   HELP_CMD_STORAGECTL, handleStorageController,    0 },
     { "showmediuminfo",     USAGE_SHOWMEDIUMINFO,   VBMG_CMD_TODO, handleShowMediumInfo,       0 },
     { "showhdinfo",         USAGE_SHOWMEDIUMINFO,   VBMG_CMD_TODO, handleShowMediumInfo,       0 }, /* backward compatibility */

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

@@ -126 +126 @@
     USAGE_I_DUMPHDINFO,
     USAGE_STORAGEATTACH,
-    USAGE_STORAGECONTROLLER,
 #ifdef VBOX_WITH_GUEST_CONTROL
     USAGE_GUESTCONTROL,

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

@@ -625 +625 @@
                      "\n", SEP);
 
-    if (enmCommand == USAGE_STORAGECONTROLLER || enmCommand == USAGE_S_ALL)
-        RTStrmPrintf(pStrm,
-                           "%s storagectl %s      <uuid|vmname>\n"
-                     "                            --name <name>\n"
-                     "                            [--add ide|sata|scsi|floppy|sas|usb|pcie|virtio]\n"
-                     "                            [--controller LSILogic|LSILogicSAS|BusLogic|\n"
-                     "                                          IntelAHCI|PIIX3|PIIX4|ICH6|I82078|\n"
-                     "                            [             USB|NVMe|VirtIO]\n"
-                     "                            [--portcount <1-n>]\n"
-                     "                            [--hostiocache on|off]\n"
-                     "                            [--bootable on|off]\n"
-                     "                            [--rename <name>]\n"
-                     "                            [--remove]\n"
-                     "\n", SEP);
-
     if (enmCommand == USAGE_BANDWIDTHCONTROL || enmCommand == USAGE_S_ALL)
         RTStrmPrintf(pStrm,

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

@@ -990 +990 @@
 
     if (a->argc < 4)
-        return errorSyntax(USAGE_STORAGECONTROLLER, Storage::tr("Too few parameters"));
+        return errorSyntax(Storage::tr("Too few parameters"));
 
     RTGetOptInit (&GetState, a->argc, a->argv, g_aStorageControllerOptions,
@@ -1036 +1036 @@
 
             default:
-                return errorGetOpt(USAGE_STORAGECONTROLLER, c, &ValueUnion);
+                return errorGetOpt(c, &ValueUnion);
         }
     }
@@ -1056 +1056 @@
         /* it's important to always close sessions */
         a->session->UnlockMachine();
-        return errorSyntax(USAGE_STORAGECONTROLLER, Storage::tr("Storage controller name not specified\n"));
+        return errorSyntax(Storage::tr("Storage controller name not specified\n"));
     }