OpenSDV
/
original_kernel
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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.

Link: https://lkml.kernel.org/r/20240516143121.12614-1-jkacur@redhat.com

Cc: Daniel Bristot de Oliveria <bristot@kernel.org>
Signed-off-by: John Kacur <jkacur@redhat.com>
Signed-off-by: Daniel Bristot de Oliveira <bristot@kernel.org>
This commit is contained in:
John Kacur 2024-05-16 10:31:21 -04:00 committed by Daniel Bristot de Oliveira
parent 842fc5b87a
commit 59c22f70b2
3 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/tools/rtla/common_options.rst
View File

@ -14,10 +14,6 @@
Print debug info. Print debug info.
**-t**, **--trace**\[*=file*]
Save the stopped trace to [*file|osnoise_trace.txt*].
**-e**, **--event** *sys:event* **-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. 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.

4
Documentation/tools/rtla/common_osnoise_options.rst
View File

@ -25,3 +25,7 @@
Specify the minimum delta between two time reads to be considered noise. Specify the minimum delta between two time reads to be considered noise.
The default threshold is *5 us*. The default threshold is *5 us*.
**-t**, **--trace** \[*file*]
Save the stopped trace to [*file|osnoise_trace.txt*].

4
Documentation/tools/rtla/common_timerlat_options.rst
View File

@ -22,6 +22,10 @@
Save the stack trace at the *IRQ* if a *Thread* latency is higher than the Save the stack trace at the *IRQ* if a *Thread* latency is higher than the
argument in us. argument in us.
**-t**, **--trace** \[*file*]
Save the stopped trace to [*file|timerlat_trace.txt*].
**--dma-latency** *us* **--dma-latency** *us*
Set the /dev/cpu_dma_latency to *us*, aiming to bound exit from idle latencies. 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 *cyclictest* sets this value to *0* by default, use **--dma-latency** *0* to have