2023-09-19 13:41:12

by Xie XiuQi

[permalink] [raw]
Subject: [PATCH] rtla: fix a example in rtla-timerlat-hist.rst

From: Xie XiuQi <[email protected]>

The following error message is reported when running the example in document.

# timerlat hist -d 10m -c 0-4 -P d:100us:1ms -p 1ms --no-aa
Failed to set timerlat period
Could not apply config

The unit of the period is microsecond, '1ms' cannot be accepted.

usage: [rtla] timerlat hist [-h] [-q] [-d s] [-D] [-n] [-a us] [-p us] [-i us] [-T us] [-s us] ...
...
-p/--period us: timerlat period in us
...

Also fix another minor missleading comment.

Signed-off-by: Xie XiuQi <[email protected]>
---
Documentation/tools/rtla/rtla-timerlat-hist.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/tools/rtla/rtla-timerlat-hist.rst b/Documentation/tools/rtla/rtla-timerlat-hist.rst
index 057db78d4095..03b7f3deb069 100644
--- a/Documentation/tools/rtla/rtla-timerlat-hist.rst
+++ b/Documentation/tools/rtla/rtla-timerlat-hist.rst
@@ -36,11 +36,11 @@ EXAMPLE
In the example below, **rtla timerlat hist** is set to run for *10* minutes,
in the cpus *0-4*, *skipping zero* only lines. Moreover, **rtla timerlat
hist** will change the priority of the *timerlat* threads to run under
-*SCHED_DEADLINE* priority, with a *10us* runtime every *1ms* period. The
+*SCHED_DEADLINE* priority, with a *100us* runtime every *1ms* period. The
*1ms* period is also passed to the *timerlat* tracer. Auto-analysis is disabled
to reduce overhead ::

- [root@alien ~]# timerlat hist -d 10m -c 0-4 -P d:100us:1ms -p 1ms --no-aa
+ [root@alien ~]# timerlat hist -d 10m -c 0-4 -P d:100us:1ms -p 1000 --no-aa
# RTLA timerlat histogram
# Time unit is microseconds (us)
# Duration: 0 00:10:00
--
2.25.1


Subject: Re: [PATCH] rtla: fix a example in rtla-timerlat-hist.rst

On 9/19/23 15:30, Xie XiuQi wrote:
> From: Xie XiuQi <[email protected]>
>
> The following error message is reported when running the example in document.
>
> # timerlat hist -d 10m -c 0-4 -P d:100us:1ms -p 1ms --no-aa
> Failed to set timerlat period
> Could not apply config
>
> The unit of the period is microsecond, '1ms' cannot be accepted.

right, but we could also parse the -p accordingly, no?

as well as the -r for osnoise and hwnoise... and other
us only parameters....

> usage: [rtla] timerlat hist [-h] [-q] [-d s] [-D] [-n] [-a us] [-p us] [-i us] [-T us] [-s us] ...
> ...
> -p/--period us: timerlat period in us
> ...
>
> Also fix another minor missleading comment.
>
> Signed-off-by: Xie XiuQi <[email protected]>