rtla: fix a example in rtla-timerlat-hist.rst
authorXie XiuQi <xiexiuqi@huawei.com>
Tue, 19 Sep 2023 13:30:28 +0000 (21:30 +0800)
committerDaniel Bristot de Oliveira <bristot@kernel.org>
Fri, 22 Sep 2023 12:44:04 +0000 (14:44 +0200)
commit81ec384b80ffbda752c230778d39ea620c7e3bcf
treec9f4c328627486f03d80c5986db457d692c17d0c
parente8c44d3b713b96cda055a23b21e8c4f931dd159f
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>
Documentation/tools/rtla/rtla-timerlat-hist.rst