The number and breadth of cyclictest's options is huge, and just
exploring them in sequence can get the manpage reader lost.
Put the cyclictest's system-altering options:
-D, --duration=TIME
-l, --loops=LOOPS
into their own group. Adjust the Synopsis accordingly as well.
Further groupings will be added next.
Signed-off-by: Ahmed S. Darwish <darwi@xxxxxxxxxxxxx>
---
src/cyclictest/cyclictest.8 | 20 +++++++++++---------
1 file changed, 11 insertions(+), 9 deletions(-)
diff --git a/src/cyclictest/cyclictest.8 b/src/cyclictest/cyclictest.8
index 964996f..c2c963c 100644
--- a/src/cyclictest/cyclictest.8
+++ b/src/cyclictest/cyclictest.8
@@ -40,14 +40,14 @@ cyclictest \- High resolution test program
.RB [ \-\-tracemark ]
.RB [ \-D\~\c
.IR duration\-mhd ]
+.RB [ \-l\~\c
+.IR num\-loops ]
.RB [ \-f\~\c
.IR fifo\-path ]
.RB [ \-h\~\c
.IR max\-latency\-usec ]
.RB [ \-H\~\c
.IR max\-latency\-usec ]
-.RB [ \-l\~\c
-.IR num\-loops ]
.RB [ \-o\~\c
.IR oscope\-red ]
.RB [ \-\-histfile\~\c
@@ -196,7 +196,7 @@ Send break trace command when latency > USEC
.B \-\-tracemark
write a trace mark when \-b latency is exceeded.
.
-.SS "Other options"
+.SS "Test-duration options"
.
.TP
.B \-D, \-\-duration=TIME
@@ -205,6 +205,14 @@ Specify a length for the test run.
Append 'm', 'h', or 'd' to specify minutes, hours or days.
.
.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.
+.
+.SS "Other options"
+.
+.TP
.B \-F, \-\-fifo=<path>
Create a named pipe at path and write stats to it
.
@@ -229,12 +237,6 @@ Dump the latency histogram to <path> instead of stdout.
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 \\-M, \-\-refresh_on_max
Delay updating the screen until a new max latency is hit. (useful for
running cyclictest on low-bandwidth connections)
--
2.49.0
