[PATCH] Documentation: tools/rtla: remove undefined substitutions in common_options.rst

From: Sameeksha Sankpal

Date: Fri Nov 28 2025 - 10:18:48 EST


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@xxxxxxxxx>
---
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