2024-05-16 14:32:01

by John Kacur

Subject: [PATCH v4] rtla: Documentation: Fix -t, --trace

Move -t, --trace from common_options.rst to
common_osnoise_options.rst and
common_timerlat_options.rst

so that it will appear in the man pages

rtla-timerlat-hist.1
rtla-timerlat-top.1
rtla-osnoise-hist.1
rtla-osnoise-top.1

Remove the equals ('=') sign and add a space.

Signed-off-by: John Kacur <[email protected]>
---
Documentation/tools/rtla/common_options.rst | 4 ----
Documentation/tools/rtla/common_osnoise_options.rst | 4 ++++
Documentation/tools/rtla/common_timerlat_options.rst | 4 ++++
3 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/Documentation/tools/rtla/common_options.rst b/Documentation/tools/rtla/common_options.rst
index 7ac7b7581466..2dc1575210aa 100644
--- a/Documentation/tools/rtla/common_options.rst
+++ b/Documentation/tools/rtla/common_options.rst
@@ -14,10 +14,6 @@

Print debug info.

-**-t**, **--trace**\[*=file*]
-
- Save the stopped trace to [*file|osnoise_trace.txt*].
-
**-e**, **--event** *sys:event*

Enable an event in the trace (**-t**) session. The argument can be a specific event, e.g., **-e** *sched:sched_switch*, or all events of a system group, e.g., **-e** *sched*. Multiple **-e** are allowed. It is only active when **-t** or **-a** are set.
diff --git a/Documentation/tools/rtla/common_osnoise_options.rst b/Documentation/tools/rtla/common_osnoise_options.rst
index f792ca58c211..d73de2d58f5f 100644
--- a/Documentation/tools/rtla/common_osnoise_options.rst
+++ b/Documentation/tools/rtla/common_osnoise_options.rst
@@ -25,3 +25,7 @@

Specify the minimum delta between two time reads to be considered noise.
The default threshold is *5 us*.
+
+**-t**, **--trace** \[*file*]
+
+ Save the stopped trace to [*file|osnoise_trace.txt*].
diff --git a/Documentation/tools/rtla/common_timerlat_options.rst b/Documentation/tools/rtla/common_timerlat_options.rst
index 090700a6ae9f..cef6651f1435 100644
--- a/Documentation/tools/rtla/common_timerlat_options.rst
+++ b/Documentation/tools/rtla/common_timerlat_options.rst
@@ -22,6 +22,10 @@
Save the stack trace at the *IRQ* if a *Thread* latency is higher than the
argument in us.

+**-t**, **--trace** \[*file*]
+
+ Save the stopped trace to [*file|timerlat_trace.txt*].
+
**--dma-latency** *us*
Set the /dev/cpu_dma_latency to *us*, aiming to bound exit from idle latencies.
*cyclictest* sets this value to *0* by default, use **--dma-latency** *0* to have
--
2.44.0

2024-05-17 19:08:36

by Steven Rostedt

Subject: Re: [PATCH v4] rtla: Documentation: Fix -t, --trace

John,

FYI, please email [email protected] instead of
linux-trace-devel, as this code lives in the kernel proper, and the
patchwork attached to linux-trace-devel doesn't follow updates that go
there.

The patchwork for linux-trace-kernel will automatically update patches that
are applied to Linus's tree.

Thanks,

-- Steve


On Thu, 16 May 2024 10:31:21 -0400
John Kacur <[email protected]> wrote:

> Move -t, --trace from common_options.rst to
> common_osnoise_options.rst and
> common_timerlat_options.rst

>
> so that it will appear in the man pages
>
> rtla-timerlat-hist.1
> rtla-timerlat-top.1
> rtla-osnoise-hist.1
> rtla-osnoise-top.1
>
> Remove the equals ('=') sign and add a space.
>
> Signed-off-by: John Kacur <[email protected]>