Changeset 94213 in vbox

Timestamp:

Mar 13, 2022 8:57:16 PM (3 years ago)

Author:

vboxsync

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

150469

Message:

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

Location:

trunk

Files:

• doc/manual/Config.kmk (modified) (1 diff)
• doc/manual/en_US/man_VBoxManage-usbdevsource.xml (modified) (3 diffs)
• doc/manual/en_US/user_VBoxManage.xml (modified) (1 diff)
• doc/manual/ru_RU/man_VBoxManage-usbdevsource.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/VBoxManageUSB.cpp (modified) (3 diffs)

trunk/doc/manual/Config.kmk

@@ -82 +82 @@
         man_VBoxManage-metrics.xml \
         man_VBoxManage-natnetwork.xml \
-        man_VBoxManage-hostonlyif.xml
+        man_VBoxManage-hostonlyif.xml \
+        man_VBoxManage-usbdevsource.xml
 
 ## List of user manual XML files.

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

@@ -20 +20 @@
 <refentry id="vboxmanage-usbdevsource" lang="en">
   <refentryinfo>
-    <pubdate>September 2019</pubdate>
+    <pubdate>$Date$</pubdate>
     <title>VBoxManage usbdevsource</title>
   </refentryinfo>
 
   <refmeta>
-    <refentrytitle>VBoxManage-usbdevsource</refentrytitle>
+    <refentrytitle>vboxmanage-usbdevsource</refentrytitle>
     <manvolnum>1</manvolnum>
   </refmeta>
@@ -32 +32 @@
     <refname>vboxmanage-usbdevsource</refname>
     <refpurpose>add and remove USB device sources</refpurpose>
-    <refclass>Oracle VM VirtualBox</refclass>
+    <refclass>&product-name;</refclass>
   </refnamediv>
 
@@ -82 +82 @@
           <listitem><para>
               Specifies the USB proxy service backend to use.
-            </para><remark>
-              What is the USB proxy service? How do you
-              determine the backend to use?
-            </remark></listitem>
+            </para><para>
+              For now only USBIP is supported to specify a remote
+              server using the USB/IP protocol.
+            </para></listitem>
         </varlistentry>
       </variablelist>

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -1127 +1127 @@
   <xi:include href="user_man_VBoxManage-dhcpserver.xml"     xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
-  <sect1 id="vboxmanage-usbdevsource">
-
-    <title>VBoxManage usbdevsource</title>
-
-    <para>
-      The <command>usbdevsource</command> commands enable you to add and
-      remove USB devices globally.
-    </para>
-
-    <para>
-      The following command adds a USB device.
-    </para>
-
-<screen>VBoxManage usbdevsource add &lt;source name&gt;
-                            --backend &lt;backend&gt;
-                            --address &lt;address&gt;
-    </screen>
-
-    <para>
-      Where the command line options are as follows:
-    </para>
-
-    <itemizedlist>
-
-      <listitem>
-        <para>
-          <computeroutput>&lt;source name&gt;</computeroutput>:
-          Specifies the ID of the source USB device to be added.
-          Mandatory.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          <computeroutput>--backend &lt;backend&gt;</computeroutput>:
-          Specifies the USB proxy service backend to use. Mandatory.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          <computeroutput> --address &lt;address&gt;</computeroutput>:
-          Specifies the backend specific address. Mandatory.
-        </para>
-      </listitem>
-
-    </itemizedlist>
-
-    <para>
-      The following command removes a USB device.
-    </para>
-
-<screen>VBoxManage usbdevsource remove &lt;source name&gt;
-    </screen>
-
-    <para>
-      Where the command line options are as follows:
-    </para>
-
-    <itemizedlist>
-
-      <listitem>
-        <para>
-          <computeroutput>&lt;source name&gt;</computeroutput>:
-          Specifies the ID of the source USB device to be removed.
-          Mandatory.
-        </para>
-      </listitem>
-
-    </itemizedlist>
-
-  </sect1>
+  <xi:include href="user_man_VBoxManage-usbdevsource.xml"   xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
   <xi:include href="user_man_VBoxManage-extpack.xml"        xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />

trunk/doc/manual/ru_RU/man_VBoxManage-usbdevsource.xml

@@ -25 +25 @@
 
   <refmeta>
-    <refentrytitle>VBoxManage-usbdevsource</refentrytitle>
+    <refentrytitle>vboxmanage-usbdevsource</refentrytitle>
     <manvolnum>1</manvolnum>
   </refmeta>

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

@@ -256 +256 @@
     { "convertfromraw",     USAGE_S_NEWCMD,HELP_CMD_CONVERTFROMRAW, handleConvertFromRaw,       VBMG_CMD_F_NO_COM },
     { "convertdd",          USAGE_S_NEWCMD,HELP_CMD_CONVERTFROMRAW, handleConvertFromRaw,       VBMG_CMD_F_NO_COM },
-    { "usbdevsource",       USAGE_USBDEVSOURCE,     VBMG_CMD_TODO, handleUSBDevSource,         0 },
+    { "usbdevsource",       USAGE_S_NEWCMD,  HELP_CMD_USBDEVSOURCE, handleUSBDevSource,         0 },
     { "cloudprofile",       USAGE_S_NEWCMD,      HELP_CMD_CLOUDPROFILE, handleCloudProfile,         0 },
     { "cloud",              USAGE_S_NEWCMD,         HELP_CMD_CLOUD, handleCloud,               0 },

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

@@ -118 +118 @@
     USAGE_I_GUESTSTATS,
     USAGE_I_REPAIRHD,
-    USAGE_USBDEVSOURCE,
     /* Insert new entries before this line, but only if it is not an option
      * to go for the new style command and help handling (see e.g. extpack,

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

@@ -641 +641 @@
                      "\n", SEP);
 
-    if (enmCommand == USAGE_USBDEVSOURCE || enmCommand == USAGE_S_ALL)
-    {
-        RTStrmPrintf(pStrm,
-                           "%s usbdevsource %s    add <source name>\n"
-                     "                            --backend <backend>\n"
-                     "                            --address <address>\n"
-                           "%s usbdevsource %s    remove <source name>\n"
-                     "\n", SEP, SEP);
-    }
-
 #ifndef VBOX_ONLY_DOCS /* Converted to man page, not needed. */
     if (enmCommand == USAGE_S_ALL)

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

@@ -569 +569 @@
     /* at least: 0: command, 1: source id */
     if (a->argc < 2)
-        return errorSyntax(USAGE_USBDEVSOURCE, Usb::tr("Not enough parameters"));
+        return errorSyntax(Usb::tr("Not enough parameters"));
 
     ComPtr<IHost> host;
     if (!strcmp(a->argv[0], "add"))
     {
+        setCurrentSubcommand(HELP_SCOPE_USBDEVSOURCE_ADD);
+
         Bstr strBackend;
         Bstr strAddress;
         if (a->argc != 6)
-            return errorSyntax(USAGE_USBDEVSOURCE, Usb::tr("Invalid number of parameters"));
+            return errorSyntax(Usb::tr("Invalid number of parameters"));
 
         for (int i = 2; i < a->argc; i++)
@@ -592 +594 @@
             }
             else
-                return errorSyntax(USAGE_USBDEVSOURCE, Usb::tr("Parameter \"%s\" is invalid"), a->argv[i]);
+                return errorSyntax(Usb::tr("Parameter \"%s\" is invalid"), a->argv[i]);
         }
 
@@ -605 +607 @@
     else if (!strcmp(a->argv[0], "remove"))
     {
+        setCurrentSubcommand(HELP_SCOPE_USBDEVSOURCE_REMOVE);
         CHECK_ERROR_RET(a->virtualBox, COMGETTER(Host)(host.asOutParam()), RTEXITCODE_FAILURE);
         CHECK_ERROR_RET(host, RemoveUSBDeviceSource(Bstr(a->argv[1]).raw()), RTEXITCODE_FAILURE);