On Thu, 2026-04-23 at 15:07 +0200, Tomas Glozar wrote: > 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. > > Signed-off-by: Tomas Glozar <[email protected]> > --- > tools/tracing/rtla/README.txt | 30 ++++++++++++++++++++++++++++++ > 1 file changed, 30 insertions(+) > > diff --git a/tools/tracing/rtla/README.txt b/tools/tracing/rtla/README.txt > index a9faee4dbb3a..8a782cd2c171 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 / TAP::Harness > +- 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. > +
Should add something explaining how to install "Test::Harness / TAP::Harness" for those who aren't familiar with the Perl ecosystem. -Crystal
