Skip to content

Commit

Permalink
rtla: Documentation: Fix -t, --trace
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
John Kacur authored and Daniel Bristot de Oliveira committed May 16, 2024
1 parent 842fc5b commit 59c22f7
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
4 changes: 0 additions & 4 deletions Documentation/tools/rtla/common_options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions Documentation/tools/rtla/common_osnoise_options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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*].
4 changes: 4 additions & 0 deletions Documentation/tools/rtla/common_timerlat_options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 59c22f7

Please sign in to comment.