Changeset 90721 in vbox for trunk/src

Timestamp:

Aug 18, 2021 2:18:24 PM (3 years ago)

Author:

vboxsync

Message:

Audio/VKAT: Brought syntax help up-to-date. ​bugref:10008

Location:

trunk/src/VBox/ValidationKit/utils/audio

Files:

• vkat.cpp (modified) (2 diffs)
• vkatCmdSelfTest.cpp (modified) (2 diffs)

trunk/src/VBox/ValidationKit/utils/audio/vkat.cpp

@@ -669 +669 @@
         case 'e':                          return "Exclude the given test id from the list";
         case 'i':                          return "Include the given test id in the list";
-        case VKAT_TEST_OPT_GUEST_ATS_ADDR: return "Address of guest ATS to connect to";
-        case VKAT_TEST_OPT_GUEST_ATS_PORT: return "Port of guest ATS to connect to [6042]";
-        case VKAT_TEST_OPT_HOST_ATS_ADDR:  return "Address of host ATS to connect to";
-        case VKAT_TEST_OPT_HOST_ATS_PORT:  return "Port of host ATS to connect to [6052]";
+        case VKAT_TEST_OPT_COUNT:          return "Number of test iterations to perform for selected tests\n"
+                                                  "    Default: random number";
+        case VKAT_TEST_OPT_DEV:            return "Name of the input/output device to use\n"
+                                                  "    Default: default device";
+        case VKAT_TEST_OPT_GUEST_ATS_ADDR: return "Address of guest ATS to connect to\n"
+                                                  "    Default: " ATS_TCP_DEF_CONNECT_GUEST_STR;
+        case VKAT_TEST_OPT_GUEST_ATS_PORT: return "Port of guest ATS to connect to (needs NAT port forwarding)\n"
+                                                  "    Default: 6042"; /* ATS_TCP_DEF_CONNECT_PORT_GUEST */
+        case VKAT_TEST_OPT_HOST_ATS_ADDR:  return "Address of host ATS to connect to\n"
+                                                  "    Default: " ATS_TCP_DEF_CONNECT_HOST_ADDR_STR;
+        case VKAT_TEST_OPT_HOST_ATS_PORT:  return "Port of host ATS to connect to\n"
+                                                  "    Default: 6052"; /* ATS_TCP_DEF_BIND_PORT_VALKIT */
         case VKAT_TEST_OPT_MODE:           return "Specifies the test mode to use when running the tests";
         case VKAT_TEST_OPT_NO_VERIFY:      return "Skips the verification step";
         case VKAT_TEST_OPT_OUTDIR:         return "Specifies the output directory to use";
         case VKAT_TEST_OPT_PAUSE:          return "Not yet implemented";
-        case VKAT_TEST_OPT_PCM_HZ:         return "Specifies the PCM Hetz (Hz) rate to use [44100]";
-        case VKAT_TEST_OPT_PCM_BIT:        return "Specifies the PCM sample bits (i.e. 16) to use [16]";
-        case VKAT_TEST_OPT_PCM_CHAN:       return "Specifies the number of PCM channels to use [2]";
-        case VKAT_TEST_OPT_PCM_SIGNED:     return "Specifies whether to use signed (true) or unsigned (false) samples [true]";
+        case VKAT_TEST_OPT_PCM_HZ:         return "Specifies the PCM Hetz (Hz) rate to use\n"
+                                                  "    Default: 44100";
+        case VKAT_TEST_OPT_PCM_BIT:        return "Specifies the PCM sample bits (i.e. 16) to use\n"
+                                                  "    Default: 16";
+        case VKAT_TEST_OPT_PCM_CHAN:       return "Specifies the number of PCM channels to use\n"
+                                                  "    Default: 2";
+        case VKAT_TEST_OPT_PCM_SIGNED:     return "Specifies whether to use signed (true) or unsigned (false) samples\n"
+                                                  "    Default: true";
         case VKAT_TEST_OPT_TAG:            return "Specifies the test set tag to use";
         case VKAT_TEST_OPT_TEMPDIR:        return "Specifies the temporary directory to use";
@@ -1155 +1167 @@
         }
     }
-
-    RTStrmPrintf(pStrm, "\nDefault values for an option are displayed in [] if available.\n");
 
     return RTEXITCODE_SUCCESS;

trunk/src/VBox/ValidationKit/utils/audio/vkatCmdSelfTest.cpp

@@ -102 +102 @@
      * The self-test does the following:
      * - 1. a) Creates an ATS instance to emulate the guest mode ("--mode guest")
-     *         at port 6042 (ATS_TCP_GUEST_DEFAULT_PORT).
+     *         at port 6042 (ATS_TCP_DEF_BIND_PORT_GUEST).
      *      or
      *      b) Connect to an already existing guest ATS instance if "--guest-ats-address" is specified.
      *      This makes it more flexible in terms of testing / debugging.
      * - 2. Uses the Validation Kit audio backend, which in turn creates an ATS instance
-     *      at port 6052 (ATS_TCP_HOST_DEFAULT_PORT).
+     *      at port 6052 (ATS_TCP_DEF_BIND_PORT_HOST).
      * - 3. Executes a complete test run locally (e.g. without any guest (VM) involved).
      */
@@ -237 +237 @@
         case 'e':                              return "Exclude the given test id from the list";
         case 'i':                              return "Include the given test id in the list";
-        case VKAT_SELFTEST_OPT_GUEST_ATS_ADDR: return "Address of guest ATS to connect to";
-        case VKAT_SELFTEST_OPT_GUEST_ATS_PORT: return "Port of guest ATS to connect to [6042]";
-        case VKAT_SELFTEST_OPT_HOST_ATS_ADDR:  return "Address of host ATS to connect to";
-        case VKAT_SELFTEST_OPT_HOST_ATS_PORT:  return "Port of host ATS to connect to [6052]";
+        case VKAT_SELFTEST_OPT_GUEST_ATS_ADDR: return "Address of guest ATS to connect to\n"
+                                                      "    Default: 127.0.0.1; will start own guest ATS";
+        case VKAT_SELFTEST_OPT_GUEST_ATS_PORT: return "Port of guest ATS to connect to\n"
+                                                      "    Default: 6042"; /* ATS_TCP_DEF_CONNECT_PORT_GUEST */
+        case VKAT_SELFTEST_OPT_HOST_ATS_ADDR:  return "Address of host ATS to connect to\n"
+                                                      "    Default: " ATS_TCP_DEF_CONNECT_HOST_ADDR_STR;
+        case VKAT_SELFTEST_OPT_HOST_ATS_PORT:  return "Port of host ATS to connect to\n"
+                                                      "    Default: 6052"; /* ATS_TCP_DEF_BIND_PORT_VALKIT */
         default:  return NULL;
     }