public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Tomas Glozar <tglozar@redhat.com>
To: Steven Rostedt <rostedt@goodmis.org>,
	Masami Hiramatsu <mhiramat@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>
Cc: linux-trace-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	Mathieu Desnoyers <mathieu.desnoyers@efficios.com>,
	John Kacur <jkacur@redhat.com>,
	Luis Goncalves <lgoncalv@redhat.com>,
	Costa Shulyupin <costa.shul@redhat.com>,
	Crystal Wood <crwood@redhat.com>,
	Attila Fazekas <afazekas@redhat.com>,
	Tomas Glozar <tglozar@redhat.com>
Subject: [PATCH 7/9] Documentation/rtla: Mention default cgroup state
Date: Fri, 10 Oct 2025 10:33:36 +0200	[thread overview]
Message-ID: <20251010083338.478961-8-tglozar@redhat.com> (raw)
In-Reply-To: <20251010083338.478961-1-tglozar@redhat.com>

The RTLA option -C/--cgroup is used to set a cgroup for workload
threads. This is either a specific cgroup, if passed an argument, or
rtla's cgroup, if no argument is given.

Expand the documentation of the -C option to also include the
information about the cgroup settings when the option is not specified.

Signed-off-by: Tomas Glozar <tglozar@redhat.com>
---
 Documentation/tools/rtla/common_options.txt | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/tools/rtla/common_options.txt b/Documentation/tools/rtla/common_options.txt
index b842f065c8f6..26e94d291a70 100644
--- a/Documentation/tools/rtla/common_options.txt
+++ b/Documentation/tools/rtla/common_options.txt
@@ -48,6 +48,8 @@
 
         Set a *cgroup* to the tracer's threads. If the **-C** option is passed without arguments, the tracer's thread will inherit **rtla**'s *cgroup*. Otherwise, the threads will be placed on the *cgroup* passed to the option.
 
+        If not set, the behavior differs between workload types. User workloads created by rtla will inherit rtla's cgroup. Kernel workloads are assigned the root cgroup.
+
 **--warm-up** *s*
 
         After starting the workload, let it run for *s* seconds before starting collecting the data, allowing the system to warm-up. Statistical data generated during warm-up is discarded.
-- 
2.51.0


  parent reply	other threads:[~2025-10-10  8:34 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-10  8:33 [PATCH 0/9] Documentation/rtla: Cover default options Tomas Glozar
2025-10-10  8:33 ` [PATCH 1/9] Documentation/rtla: Fix typo in common_options.txt Tomas Glozar
2025-10-10  8:33 ` [PATCH 2/9] Documentation/rtla: Fix typo in common_timerlat_options.txt Tomas Glozar
2025-10-10  8:33 ` [PATCH 3/9] Documentation/rtla: Fix typo in rtla-timerlat-top.rst Tomas Glozar
2025-10-10  8:33 ` [PATCH 4/9] Documentation/rtla: Fix typo in common_timerlat_options.txt Tomas Glozar
2025-10-10  8:33 ` [PATCH 5/9] Documentation/rtla: Correct tracer name for common options Tomas Glozar
2025-10-10  8:33 ` [PATCH 6/9] Documentation/rtla: Mention default priority Tomas Glozar
2025-10-10  8:33 ` Tomas Glozar [this message]
2025-10-10  8:33 ` [PATCH 8/9] Documentation/trace: Specify exact priority for timerlat Tomas Glozar
2025-10-10  8:33 ` [PATCH 9/9] Documentation/rtla: Include defaults for tracer options Tomas Glozar
2025-11-03 23:35 ` [PATCH 0/9] Documentation/rtla: Cover default options Jonathan Corbet
2025-11-04  0:22   ` Steven Rostedt
2025-11-05 18:19     ` Jonathan Corbet
2025-11-04  0:32   ` Bagas Sanjaya

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=20251010083338.478961-8-tglozar@redhat.com \
    --to=tglozar@redhat.com \
    --cc=afazekas@redhat.com \
    --cc=corbet@lwn.net \
    --cc=costa.shul@redhat.com \
    --cc=crwood@redhat.com \
    --cc=jkacur@redhat.com \
    --cc=lgoncalv@redhat.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-trace-kernel@vger.kernel.org \
    --cc=mathieu.desnoyers@efficios.com \
    --cc=mhiramat@kernel.org \
    --cc=rostedt@goodmis.org \
    /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