On Fri, 4 Jul 2025, Ahmed S. Darwish wrote: > The cyclictest's SYNOPSIS blurb is buggy and incomplete. > > For the cyclictest's flag list: > > - Remove 'f', for --fifo, as it's not a flag and requires the fifo's path > - Add 'N', for --nsecs > - Add 'R', for --resolution > - Add 'S', for --smp > - Add 'u', for --unbuffered > - Add 'x', for --posix_timers > > For options with arguments, expand the argument names with something > comprehensible since the whole purpose of the SYNOPSIS section is to get, > in a blitz, an understanding of the tool's actual options. The original > argument names, especially when -combined with the one-letter option's > shorthand form, were totally -incomprehensible. > > For consistency, be coherent regarding the arguments' names; e.g., > "*-path" for all file paths like file-path and fifo-path, "proc-set" for > cpuset-related arguments, "num-*" for counts like num-threads and > num-loops; "*-usec" for microsecond arguments, and so on. > > Also add the missing options --deepest-idle-state, --histfile, --latency, > --mainaffinity, --policy, --spike, --spike-nodes, --dbg_cyclictest, > --default-system, --smi, --priospread, --smi, and --tracemark. Do not > add --laptop since it is deprecated. > > Note, this makes the cyclictest's SYNOPSIS blurb complete and gives a > comprehensive view of cyclictest's abilities in a glance. > > Signed-off-by: Ahmed S. Darwish <darwi@xxxxxxxxxxxxx> > --- > src/cyclictest/cyclictest.8 | 57 ++++++++++++++++++++++++++----------- > 1 file changed, 41 insertions(+), 16 deletions(-) > > diff --git a/src/cyclictest/cyclictest.8 b/src/cyclictest/cyclictest.8 > index f093677..0271f5c 100644 > --- a/src/cyclictest/cyclictest.8 > +++ b/src/cyclictest/cyclictest.8 > @@ -7,33 +7,58 @@ cyclictest \- High resolution test program > . > .SH Synopsis > .SY cyclictest > -.RB [ \-fmMnqrsMv ] > +.RB [ \-mMNqrRsSuvx ] > .RB [ \-a\~\c > -.IR proc ] > +.IR proc\-set ] > .RB [ \-A\~\c > -.IR align ] > +.IR alignment\-usec ] > .RB [ \-b\~\c > -.IR usec ] > +.IR break\-usec ] > .RB [ \-c\~\c > -.IR clock ] > +.IR clock\-type ] > .RB [ \-d\~\c > -.IR dist ] > +.IR distance\-usec ] > +.RB [ \-D\~\c > +.IR duration\-mhd ] > +.RB [ \-f\~\c > +.IR fifo\-path ] > .RB [ \-h\~\c > -.IR histogram ] > +.IR max\-latency\-usec ] > +.RB [ \-H\~\c > +.IR max\-latency\-usec ] > .RB [ \-i\~\c > -.IR intv ] > -.RB [ \-\-json\~\c > -.IR filename ] > +.IR interval\-usec ] > .RB [ \-l\~\c > -.IR loop ] > +.IR num\-loops ] > .RB [ \-o\~\c > -.IR red ] > +.IR oscope\-red ] > .RB [ \-p\~\c > -.IR prio ] > +.IR thread\-prio ] > .RB [ \-t\~\c > -.IR num ] > -.RB [ \-D\~\c > -.IR time ] > +.IR num\-threads ] > +.RB [ \-\-deepest\-idle\-state\~\c > +.IR idle-state-num ] > +.RB [ \-\-histfile\~\c > +.IR file\-path ] > +.RB [ \-\-json\~\c > +.IR file\-path ] > +.RB [ \-\-latency\~\c > +.IR pm\-c\-state ] > +.RB [ \-\-mainaffinity\~\c > +.IR proc-set ] > +.RB [ \-\-policy\~\c > +.IR threads\-sched\-policy ] > +.RB [ \-\-secaligned\~\c > +.IR wakeup\-usec ] > +.RB [ \-\-spike\~\c > +.IR trigger\-point-usec ] > +.RB [ \-\-spike\-nodes\~\c > +.IR num\-nodes ] > +.RB [ \-\-dbg_cyclictest ] > +.RB [ \-\-default\-system ] > +.RB [ \-\-priospread ] > +.RB [ \-\-smi ] > +.RB [ \-\-tracemark ] > .YS > . > .SH Options > -- > 2.49.0 > > > Signed-off-by: John Kacur <jkacur@xxxxxxxxxx>
