linux-next/Documentation/tools/rtla/common_osnoise_options.rst
John Kacur 59c22f70b2 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>
2024-05-16 16:52:16 +02:00

32 lines
980 B
ReStructuredText

**-a**, **--auto** *us*
Set the automatic trace mode. This mode sets some commonly used options
while debugging the system. It is equivalent to use **-s** *us* **-T 1 -t**.
**-p**, **--period** *us*
Set the *osnoise* tracer period in microseconds.
**-r**, **--runtime** *us*
Set the *osnoise* tracer runtime in microseconds.
**-s**, **--stop** *us*
Stop the trace if a single sample is higher than the argument in microseconds.
If **-T** is set, it will also save the trace to the output.
**-S**, **--stop-total** *us*
Stop the trace if the total sample is higher than the argument in microseconds.
If **-T** is set, it will also save the trace to the output.
**-T**, **--threshold** *us*
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*].