summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJohn Kacur <jkacur@redhat.com>2021-10-01 10:29:56 -0400
committerJohn Kacur <jkacur@redhat.com>2021-10-04 10:02:24 -0400
commite1d4c3e7714d45de6692780b9573d0a5914ddddb (patch)
treebc59aa7602b1c9d7a9d4e09424eab0ad340a88b0
parente0183e7779e6b3667921b6918c507b2edd04e93b (diff)
downloadrt-tests-e1d4c3e7714d45de6692780b9573d0a5914ddddb.tar.gz
rt-tests: Update the help and man page for --latency
- Update the help and man page for --latency - Fix some sorting of --latency and --loops Tested-by: Leah Leshchinsky <lleshchi@redhat.com> Signed-off-by: John Kacur <jkacur@redhat.com>
-rw-r--r--src/cyclictest/cyclictest.812
-rw-r--r--src/cyclictest/cyclictest.c6
2 files changed, 10 insertions, 8 deletions
diff --git a/src/cyclictest/cyclictest.8 b/src/cyclictest/cyclictest.8
index abc56e8..dc0a278 100644
--- a/src/cyclictest/cyclictest.8
+++ b/src/cyclictest/cyclictest.8
@@ -67,9 +67,6 @@ Specify a length for the test run.
.br
Append 'm', 'h', or 'd' to specify minutes, hours or days.
.TP
-.B \-\-latency=PM_Q0S
-write PM_Q0S to /dev/cpu_dma_latency
-.TP
.B \-F, \-\-fifo=<path>
Create a named pipe at path and write stats to it
.TP
@@ -88,12 +85,15 @@ Set the base interval of the thread(s) in microseconds (default is 1000us). This
.B \-\-json=FILENAME
Write final results into FILENAME, JSON formatted.
.TP
-.B \-l, \-\-loops=LOOPS
-Set the number of loops. The default is 0 (endless). This option is useful for automated tests with a given number of test cycles. Cyclictest is stopped once the number of timer intervals has been reached.
-.TP
.B \-\-laptop
Save battery when running cyclictest. This will give you poorer realtime results, but will not drain your battery so quickly.
.TP
+.B \-\-latency=PM_Q0S
+power management latency target value. This value is written to /dev/cpu_dma_latency and affects c-states. The default is 0
+.TP
+.B \-l, \-\-loops=LOOPS
+Set the number of loops. The default is 0 (endless). This option is useful for automated tests with a given number of test cycles. Cyclictest is stopped once the number of timer intervals has been reached.
+.TP
.B \-\-mainaffinity=CPUSET
Run the main thread on CPU #N. This only affects the main thread and not the measurement threads
.TP
diff --git a/src/cyclictest/cyclictest.c b/src/cyclictest/cyclictest.c
index f8f7dbc..067b753 100644
--- a/src/cyclictest/cyclictest.c
+++ b/src/cyclictest/cyclictest.c
@@ -823,7 +823,6 @@ static void display_help(int error)
"-d DIST --distance=DIST distance of thread intervals in us, default=500\n"
"-D --duration=TIME specify a length for the test run.\n"
" Append 'm', 'h', or 'd' to specify minutes, hours or days.\n"
- " --latency=PM_QOS write PM_QOS to /dev/cpu_dma_latency\n"
"-F --fifo=<path> create a named pipe at path and write stats to it\n"
"-h --histogram=US dump a latency histogram to stdout after the run\n"
" US is the max latency time to be tracked in microseconds\n"
@@ -832,10 +831,13 @@ static void display_help(int error)
" --histfile=<path> dump the latency histogram to <path> instead of stdout\n"
"-i INTV --interval=INTV base interval of thread in us default=1000\n"
" --json=FILENAME write final results into FILENAME, JSON formatted\n"
- "-l LOOPS --loops=LOOPS number of loops: default=0(endless)\n"
" --laptop Save battery when running cyclictest\n"
" This will give you poorer realtime results\n"
" but will not drain your battery so quickly\n"
+ " --latency=PM_QOS power management latency target value\n"
+ " This value is written to /dev/cpu_dma_latency\n"
+ " and affects c-states. The default is 0\n"
+ "-l LOOPS --loops=LOOPS number of loops: default=0(endless)\n"
" --mainaffinity=CPUSET\n"
" Run the main thread on CPU #N. This only affects\n"
" the main thread and not the measurement threads\n"