summaryrefslogtreecommitdiff
path: root/axfer
diff options
context:
space:
mode:
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>2019-01-27 14:27:11 +0900
committerTakashi Iwai <tiwai@suse.de>2019-01-29 16:43:09 +0100
commit83bce86c26be6c04bcef584fbe00f320b3582c92 (patch)
tree066bac0f9f6f6a19e9a6dae104954cc49c524074 /axfer
parent116488e5f2f1b897084bd151381ee254e1cc177d (diff)
downloadalsa-utils-83bce86c26be6c04bcef584fbe00f320b3582c92.tar.gz
axfer: add a section about unit test
Two unit tests are available to check internal implementation of axfer. They perform file I/O for many times and take much time to finish. This commit adds a section about it. Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp> Signed-off-by: Takashi Iwai <tiwai@suse.de>
Diffstat (limited to 'axfer')
-rw-r--r--axfer/axfer-transfer.116
-rw-r--r--axfer/axfer.17
2 files changed, 23 insertions, 0 deletions
diff --git a/axfer/axfer-transfer.1 b/axfer/axfer-transfer.1
index 4ff6082..02e5b4c 100644
--- a/axfer/axfer-transfer.1
+++ b/axfer/axfer-transfer.1
@@ -971,6 +971,22 @@ some scenarios below, no copying occurs between modules.
- xfer(mmap/interleaved), mapper(single), container(any)
- xfer(mmap/non\-interleaved), mapper(multiple), containers(any)
+.SS Unit test
+
+For each of the
+.I mapper
+and
+.I container
+module, unit test is available. To run the tests, execute below command:
+
+.nf
+$ make test
+.fi
+
+Each test iterates writing to file and reading to the file for many times and it
+takes long time to finish. Please take care of the execution time if running on
+any CI environment.
+
.SH SEE ALSO
\fB
axfer(1),
diff --git a/axfer/axfer.1 b/axfer/axfer.1
index bfcd15d..3ae9c8e 100644
--- a/axfer/axfer.1
+++ b/axfer/axfer.1
@@ -75,6 +75,13 @@ Operates for playback transmission.
.I EXIT_FAILURE
(1).
+.SH UNIT TEST
+
+This program has unit tests for internal implementation. Please refer to the
+manual of
+.I axfer-transfer
+for details.
+
.SH COMPATIBILITY TO APLAY
The