From: Sameeksha Sankpal <sameekshasankpal@gmail.com>
To: rostedt@goodmis.org, corbet@lwn.net
Cc: linux-trace-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org,
Sameeksha Sankpal <sameekshasankpal@gmail.com>
Subject: [PATCH] Documentation: tools/rtla: remove undefined substitutions in common_options.rst
Date: Fri, 28 Nov 2025 20:48:38 +0530 [thread overview]
Message-ID: <20251128151838.7985-1-sameekshasankpal@gmail.com> (raw)
The RTLA common options documentation uses several Sphinx substitution
placeholders (|threshold|, |tool|, |thresharg|, |tracer|, |actionsperf|)
that are not defined anywhere in the tree. This causes the htmldocs
build to fail with multiple "Undefined substitution" errors.
Replace these undefined substitutions with plain text or generic
placeholders (<tool>, <threshold-option>, <tracer>) to ensure the
documentation builds cleanly while preserving the intended meaning of
the examples.
Signed-off-by: Sameeksha Sankpal <sameekshasankpal@gmail.com>
---
Documentation/tools/rtla/common_options.rst | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/Documentation/tools/rtla/common_options.rst b/Documentation/tools/rtla/common_options.rst
index 77ef35d3f831..bd5a6f32f5bf 100644
--- a/Documentation/tools/rtla/common_options.rst
+++ b/Documentation/tools/rtla/common_options.rst
@@ -56,7 +56,7 @@
**--on-threshold** *action*
Defines an action to be executed when tracing is stopped on a latency threshold
- specified by |threshold|.
+ specified by the threshold value.
Multiple --on-threshold actions may be specified, and they will be executed in
the order they are provided. If any action fails, subsequent actions in the list
@@ -85,17 +85,17 @@
Example:
- $ rtla |tool| |thresharg| 20 --on-threshold trace
- --on-threshold shell,command="grep ipi_send |tracer|\_trace.txt"
+ $ rtla <tool> <threshold-option> 20 --on-threshold trace
+ --on-threshold shell,command="grep ipi_send <tracer>\_trace.txt"
--on-threshold signal,num=2,pid=parent
- This will save a trace with the default filename "|tracer|\_trace.txt", print its
+ This will save a trace with the default filename "<tracer>\_trace.txt", print its
lines that contain the text "ipi_send" on standard output, and send signal 2
(SIGINT) to the parent process.
Performance Considerations:
- |actionsperf|
+ Note: Executing actions during tracing may introduce additional performance overhead depending on system load, system configuration, and the number of actions triggered.
**--on-end** *action*
@@ -110,7 +110,7 @@
Example:
- $ rtla |tool| -d 5s --on-end trace
+ $ rtla <tool> -d 5s --on-end trace
This runs rtla with the default options, and saves trace output at the end.
--
2.43.0
next reply other threads:[~2025-11-28 15:18 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-28 15:18 Sameeksha Sankpal [this message]
2025-11-28 21:43 ` [PATCH] Documentation: tools/rtla: remove undefined substitutions in common_options.rst Randy Dunlap
2025-11-29 9:08 ` 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=20251128151838.7985-1-sameekshasankpal@gmail.com \
--to=sameekshasankpal@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-kernel@vger.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;
as well as URLs for NNTP newsgroup(s).