[PATCH] Documentation: rtla: Correct command line example

[PATCH] Documentation: rtla: Correct command line example

[Pierre Gondois]

The '-t/-T' parameters seem to have been swapped:
-t/--trace[=file]: save the stopped trace
to [file|timerlat_trace.txt]
-T/--thread us: stop trace if the thread latency
is higher than the argument in us

Swap them back.

Signed-off-by: Pierre Gondois <pierre.gondois@arm.com>
---
 Documentation/tools/rtla/rtla-timerlat-top.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/tools/rtla/rtla-timerlat-top.rst b/Documentation/tools/rtla/rtla-timerlat-top.rst
index 1c321de1c171..7c4e4b109493 100644
--- a/Documentation/tools/rtla/rtla-timerlat-top.rst
+++ b/Documentation/tools/rtla/rtla-timerlat-top.rst
@@ -39,7 +39,7 @@ higher than *30 us*. It is also set to stop the session if a *Thread* timer
 latency higher than *30 us* is hit. Finally, it is set to save the trace
 buffer if the stop condition is hit::
 
-  [root@alien ~]# rtla timerlat top -s 30 -t 30 -T
+  [root@alien ~]# rtla timerlat top -s 30 -T 30 -t
                    Timer Latency
     0 00:00:59   |          IRQ Timer Latency (us)        |         Thread Timer Latency (us)
   CPU COUNT      |      cur       min       avg       max |      cur       min       avg       max
-- 
2.25.1

Re: [PATCH] Documentation: rtla: Correct command line example

[Daniel Bristot de Oliveira]

On 10/6/22 10:44, Pierre Gondois wrote:
> The '-t/-T' parameters seem to have been swapped:
> -t/--trace[=file]: save the stopped trace
> to [file|timerlat_trace.txt]
> -T/--thread us: stop trace if the thread latency
> is higher than the argument in us

I swapped them during the development, but it seems that I got the example
before swapping them :-).

> Swap them back.
> 
> Signed-off-by: Pierre Gondois <pierre.gondois@arm.com>

Acked-by: Daniel Bristot de Oliveira <bristot@kernel.org>

Thanks!
-- Daniel

Re: [PATCH] Documentation: rtla: Correct command line example

[Jonathan Corbet]

Pierre Gondois <pierre.gondois@arm.com> writes:

> The '-t/-T' parameters seem to have been swapped:
> -t/--trace[=file]: save the stopped trace
> to [file|timerlat_trace.txt]
> -T/--thread us: stop trace if the thread latency
> is higher than the argument in us
>
> Swap them back.
>
> Signed-off-by: Pierre Gondois <pierre.gondois@arm.com>
> ---
>  Documentation/tools/rtla/rtla-timerlat-top.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/tools/rtla/rtla-timerlat-top.rst b/Documentation/tools/rtla/rtla-timerlat-top.rst
> index 1c321de1c171..7c4e4b109493 100644
> --- a/Documentation/tools/rtla/rtla-timerlat-top.rst
> +++ b/Documentation/tools/rtla/rtla-timerlat-top.rst
> @@ -39,7 +39,7 @@ higher than *30 us*. It is also set to stop the session if a *Thread* timer
>  latency higher than *30 us* is hit. Finally, it is set to save the trace
>  buffer if the stop condition is hit::
>  
> -  [root@alien ~]# rtla timerlat top -s 30 -t 30 -T
> +  [root@alien ~]# rtla timerlat top -s 30 -T 30 -t
>                     Timer Latency

Applied, thanks.

jon