Changeset 89834 in vbox

Timestamp:

Jun 22, 2021 1:55:09 PM (4 years ago)

Author:

vboxsync

Message:

Audio/ValKit: Added more command line / syntax help. bugref:10008

Location:

trunk/src/VBox/ValidationKit/utils/audio

Files:

• vkat.cpp (modified) (3 diffs)
• vkatCmdSelfTest.cpp (modified) (1 diff)

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

@@ -593 +593 @@
     switch (pOpt->iShort)
     {
+        case 'a':                          return "Exclude all tests from the list (useful to enable single tests later with --include)";
+        case 'b':                          return "The audio backend to use";
         case 'd':                          return "Go via DrvAudio instead of directly interfacing with the backend";
+        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_DEV:            return "Use the specified audio device";
-        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 [6052].";
-        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_MODE:           return "Specifies the mode this program runs at";
-        case VKAT_TEST_OPT_NO_VERIFY:      return "Skips the verification step.";
-        case 'e':                          return "Exclude the given test id from the list";
-        case 'a':                          return "Exclude all tests from the list (useful to enable single tests later with --include)";
-        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_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_TAG:            return "Specifies the test set tag to use";
+        case VKAT_TEST_OPT_TEMPDIR:        return "Specifies the temporary directory to use";
+        case VKAT_TEST_OPT_VOL:            return "Specifies the audio volume (in percent, 0-100) to use";
+        default:
+            break;
     }
     return NULL;
@@ -759 +771 @@
 
     if (TstEnv.enmMode == AUDIOTESTMODE_UNKNOWN)
-        return RTMsgErrorExit(RTEXITCODE_SYNTAX, "No test mode specified!\n");
+        return RTMsgErrorExit(RTEXITCODE_SYNTAX, "No test mode (--mode) specified!\n");
 
     if (TstEnv.enmMode == AUDIOTESTMODE_HOST)
     {
         if (!pszGuestTcpAddr)
-            return RTMsgErrorExit(RTEXITCODE_SYNTAX, "--guest-ats-address missing\n");
+            return RTMsgErrorExit(RTEXITCODE_SYNTAX, "No guest ATS address (--guest-ats-addr) specified!\n");
     }
 
@@ -1056 +1068 @@
         }
     }
+
+    RTStrmPrintf(pStrm, "\nDefault values for an option are displayed in [] if available.\n");
+
     return RTEXITCODE_SUCCESS;
 }

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

@@ -242 +242 @@
     switch (pOpt->iShort)
     {
-        case 'b': return "The audio backend to use.";
-        case 'd': return "Go via DrvAudio instead of directly interfacing with the backend.";
+        case 'a':                              return "Exclude all tests from the list (useful to enable single tests later with --include)";
+        case 'b':                              return "The audio backend to use";
+        case 'd':                              return "Go via DrvAudio instead of directly interfacing with the backend";
+        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]";
         default:  return NULL;
     }