Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

rtla: fix a example in rtla-timerlat-hist.rst

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.

Link: https://lore.kernel.org/lkml/20230919133028.697144-1-xiexiuqi@huaweicloud.com

Signed-off-by: Xie XiuQi <xiexiuqi@huawei.com>
Signed-off-by: Daniel Bristot de Oliveira <bristot@kernel.org>

authored by

Xie XiuQi and committed by
Daniel Bristot de Oliveira
81ec384b e8c44d3b

+2 -2
+2 -2
Documentation/tools/rtla/rtla-timerlat-hist.rst
··· 36 36 In the example below, **rtla timerlat hist** is set to run for *10* minutes, 37 37 in the cpus *0-4*, *skipping zero* only lines. Moreover, **rtla timerlat 38 38 hist** will change the priority of the *timerlat* threads to run under 39 - *SCHED_DEADLINE* priority, with a *10us* runtime every *1ms* period. The 39 + *SCHED_DEADLINE* priority, with a *100us* runtime every *1ms* period. The 40 40 *1ms* period is also passed to the *timerlat* tracer. Auto-analysis is disabled 41 41 to reduce overhead :: 42 42 43 - [root@alien ~]# timerlat hist -d 10m -c 0-4 -P d:100us:1ms -p 1ms --no-aa 43 + [root@alien ~]# timerlat hist -d 10m -c 0-4 -P d:100us:1ms -p 1000 --no-aa 44 44 # RTLA timerlat histogram 45 45 # Time unit is microseconds (us) 46 46 # Duration: 0 00:10:00