public inbox for linux-trace-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Crystal Wood <crwood@redhat.com>
To: Tomas Glozar <tglozar@redhat.com>, Steven Rostedt <rostedt@goodmis.org>
Cc: John Kacur <jkacur@redhat.com>,
	Luis Goncalves <lgoncalv@redhat.com>,
	 Costa Shulyupin <costa.shul@redhat.com>,
	Wander Lairson Costa <wander@redhat.com>,
	LKML	 <linux-kernel@vger.kernel.org>,
	linux-trace-kernel	 <linux-trace-kernel@vger.kernel.org>
Subject: Re: [PATCH] rtla: Document tests in README
Date: Thu, 23 Apr 2026 17:44:49 -0500	[thread overview]
Message-ID: <c14e603b447530f65ea48274388f68bb2ff0086c.camel@redhat.com> (raw)
In-Reply-To: <20260423130759.882247-1-tglozar@redhat.com>

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 <tglozar@redhat.com>
> ---
>  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


      reply	other threads:[~2026-04-23 22:44 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-04-23 13:07 [PATCH] rtla: Document tests in README Tomas Glozar
2026-04-23 22:44 ` Crystal Wood [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=c14e603b447530f65ea48274388f68bb2ff0086c.camel@redhat.com \
    --to=crwood@redhat.com \
    --cc=costa.shul@redhat.com \
    --cc=jkacur@redhat.com \
    --cc=lgoncalv@redhat.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-trace-kernel@vger.kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=tglozar@redhat.com \
    --cc=wander@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox