diff options
| author | Tomas Glozar <tglozar@redhat.com> | 2026-05-14 09:30:38 +0200 |
|---|---|---|
| committer | Tomas Glozar <tglozar@redhat.com> | 2026-05-29 09:40:54 +0200 |
| commit | db956bcf8d681b5a01ebe04c79f6a7b29b9934f9 (patch) | |
| tree | b4a9bc144203248b533c002c1e17dbf8d80f6c6c | |
| parent | 2240050a93ac6328754f38d2545b414ba5654dc8 (diff) | |
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>
| -rw-r--r-- | tools/tracing/rtla/README.txt | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/tools/tracing/rtla/README.txt b/tools/tracing/rtla/README.txt index a9faee4dbb3a..13b4a798b487 100644 --- a/tools/tracing/rtla/README.txt +++ b/tools/tracing/rtla/README.txt @@ -42,4 +42,34 @@ For development, we suggest the following steps for compiling rtla: $ make $ sudo make install +Running tests + +RTLA has two test suites: a runtime test suite and a unit test suite. + +The runtime test suite is available as "make check" (root required) and has +the following dependencies, in addition to RTLA build dependencies: + +- Perl +- Test::Harness (libtest-harness-perl on Debian/Ubuntu, perl-Test-Harness on Fedora/RHEL) +- bash +- coreutils +- ldd +- util-linux +- procps(-ng) +- bpftool (if rtla is built against libbpf) + +as well as the following required system configuration: + +- CONFIG_OSNOISE_TRACER=y +- CONFIG_TIMERLAT_TRACER=y +- tracefs mounted and readable at /sys/kernel/tracing + +The unit test suite is available as "make unit-tests" and has the following +dependencies: + +- libcheck + +Unlike the runtime test suite, root is not required to run unit tests, nor is +a tracefs/osnoise/timerlat-capable kernel required. + For further information, please refer to the rtla man page. |