On Fri, 4 Jul 2025, Ahmed S. Darwish wrote: > 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 output options: > > --dbg_cyclictest > -o, --oscope=RED > -F, --fifo=<path> > -h, --histogram=US > -H, --histofall=MAXLATENCYINUS > --spike=<trigger> > --spike-nodes=[num of nodes] > --histfile=<path> > --json=FILENAME > -M, --refresh_on_max > -N, --nsecs > -q, --quiet > -u, --unbuffered > -v, --verbose > > 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 | 58 +++++++++++++++++++------------------ > 1 file changed, 30 insertions(+), 28 deletions(-) > > diff --git a/src/cyclictest/cyclictest.8 b/src/cyclictest/cyclictest.8 > index c2c963c..ca75884 100644 > --- a/src/cyclictest/cyclictest.8 > +++ b/src/cyclictest/cyclictest.8 > @@ -42,23 +42,23 @@ cyclictest \- High resolution test program > .IR duration\-mhd ] > .RB [ \-l\~\c > .IR num\-loops ] > +.RB [ \-\-dbg_cyclictest ] > +.RB [ \-o\~\c > +.IR oscope\-red ] > .RB [ \-f\~\c > .IR fifo\-path ] > .RB [ \-h\~\c > .IR max\-latency\-usec ] > .RB [ \-H\~\c > .IR max\-latency\-usec ] > -.RB [ \-o\~\c > -.IR oscope\-red ] > -.RB [ \-\-histfile\~\c > -.IR file\-path ] > -.RB [ \-\-json\~\c > -.IR file\-path ] > .RB [ \-\-spike\~\c > .IR trigger\-point-usec ] > .RB [ \-\-spike\-nodes\~\c > .IR num\-nodes ] > -.RB [ \-\-dbg_cyclictest ] > +.RB [ \-\-histfile\~\c > +.IR file\-path ] > +.RB [ \-\-json\~\c > +.IR file\-path ] > .RB [ \-\-smi ] > .YS > . > @@ -210,7 +210,15 @@ 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" > +.SS "Output options" > +. > +.TP > +.B \-\-dbg_cyclictest > +Print info userful for debugging cyclictest > +. > +.TP > +.B \-o, \-\-oscope=RED > +Oscilloscope mode, reduce verbose output by RED. > . > .TP > .B \-F, \-\-fifo=<path> > @@ -229,6 +237,16 @@ right that contains summary data of all thread histograms. If cyclictest > runs a single thread only, the -H option is equivalent to -h. > . > .TP > +.B \-\-spike=<trigger> > +record all spikes > trigger > +. > +.TP > +.B \-\-spike-nodes=[num of nodes] > +These are the maximum number of spikes we can record. > +.br > +The default is 1024 if not specified. > +. > +.TP > .B \-\-histfile=<path> > Dump the latency histogram to <path> instead of stdout. > . > @@ -247,29 +265,11 @@ Show results in nanoseconds instead of microseconds, which is the default > unit. > . > .TP > -.B \-o, \-\-oscope=RED > -Oscilloscope mode, reduce verbose output by RED. > -. > -.TP > .B \-q, \-\-quiet > Print a summary only on exit. Useful for automated tests, where only the > summary output needs to be captured. > . > .TP > -.B \-\-spike=<trigger> > -record all spikes > trigger > -. > -.TP > -.B \-\-spike-nodes=[num of nodes] > -These are the maximum number of spikes we can record. > -.br > -The default is 1024 if not specified. > -. > -.TP > -.B \\-\-smi > -Enable SMI count/detection on processors with SMI count support. > -. > -.TP > .B \-u, \-\-unbuffered > force unbuffered output for live processing > . > @@ -280,9 +280,11 @@ statistical information about the latency distribution. The output is sent > to stdout. The output format is: "n:c:v", where n is the task number, c is > the count, and v is the latency value in microseconds. > . > +.SS "Other options" > +. > .TP > -.B \-\-dbg_cyclictest > -Print info userful for debugging cyclictest > +.B \\-\-smi > +Enable SMI count/detection on processors with SMI count support. > . > .SH "See also" > .BR numa (3), > -- > 2.49.0 > > > Signed-off-by: John Kacur <jkacur@xxxxxxxxxx>
