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>

diff --git a/axfer/axfer-transfer.1 b/axfer/axfer-transfer.1
index 4ff60824ff17edd4cebca7153a30d2216c8f43ba..02e5b4c4ec2174754f365851ef26a9bc5dbed10b 100644 (file)
--- 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 bfcd15da340180525e0241bddffcb67444bf42e4..3ae9c8ebf89cb483b3fe1b8cbf77a6a3f7b1f25c 100644 (file)
--- 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