check-alsabat.sh: explain that we run two alsabat instances

This threw me off. Also add warning that https://manpages.org/alsabat is incomplete and never tells that it is possible to use two separate alsabat instances, nor how to invoke these (answer: omit -P or -C) Signed-off-by: Marc Herbert <[email protected]>
singalsu · Jan 8, 2024 · 84dcefd · 84dcefd
1 parent a21c389
commit 84dcefd
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/test-case/check-alsabat.sh b/test-case/check-alsabat.sh
@@ -2,15 +2,24 @@
 
 ##
 ## Case Name: check alsabat
+##
 ## Preconditions:
 ##    This test case requires physical loopback between playback and capture.
 ##    playback <=====>  capture
 ##    nocodec : no need to use hw loopback cable, It support DSP loopback by quirk
+##
 ## Description:
-##    run alsabat test on the specified pipelines
+##    Run two alsabat instances concurrently, one on each specified PCM: playback
+##    and capture.
+##
+##    Warning: as of January 2024, "man alsabat" is incomplete and
+##    documents only the "single instance" mode where a single alsabat
+##    process performs both playback and capture.
+##
 ## Case step:
 ##    1. Specify the pcm IDs for playback and catpure
 ##    3. run alsabat test
+##
 ## Expect result:
 ##    The return value of alsabat is 0
 ##