Skip to content

Commit db956bc

Browse files
rtla: Document tests in README
RTLA tests are not documented anywhere. Mention both runtime and unit tests in the README, with instructions on how to run them and a list of dependencies and required system configuration. Link: https://lore.kernel.org/r/20260514073038.204428-1-tglozar@redhat.com Signed-off-by: Tomas Glozar <tglozar@redhat.com>
1 parent 2240050 commit db956bc

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

tools/tracing/rtla/README.txt

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,34 @@ For development, we suggest the following steps for compiling rtla:
4242
$ make
4343
$ sudo make install
4444

45+
Running tests
46+
47+
RTLA has two test suites: a runtime test suite and a unit test suite.
48+
49+
The runtime test suite is available as "make check" (root required) and has
50+
the following dependencies, in addition to RTLA build dependencies:
51+
52+
- Perl
53+
- Test::Harness (libtest-harness-perl on Debian/Ubuntu, perl-Test-Harness on Fedora/RHEL)
54+
- bash
55+
- coreutils
56+
- ldd
57+
- util-linux
58+
- procps(-ng)
59+
- bpftool (if rtla is built against libbpf)
60+
61+
as well as the following required system configuration:
62+
63+
- CONFIG_OSNOISE_TRACER=y
64+
- CONFIG_TIMERLAT_TRACER=y
65+
- tracefs mounted and readable at /sys/kernel/tracing
66+
67+
The unit test suite is available as "make unit-tests" and has the following
68+
dependencies:
69+
70+
- libcheck
71+
72+
Unlike the runtime test suite, root is not required to run unit tests, nor is
73+
a tracefs/osnoise/timerlat-capable kernel required.
74+
4575
For further information, please refer to the rtla man page.

0 commit comments

Comments
 (0)