On Fri, 4 Jul 2025, Ahmed S. Darwish wrote: > Add a cyclictest example invocation, while warning the user that testing > a realtime system is hardware and workload dependent. > > Signed-off-by: Ahmed S. Darwish <darwi@xxxxxxxxxxxxx> > --- > src/cyclictest/cyclictest.8 | 18 ++++++++++++++++++ > 1 file changed, 18 insertions(+) > > diff --git a/src/cyclictest/cyclictest.8 b/src/cyclictest/cyclictest.8 > index 12fb9c1..16e8190 100644 > --- a/src/cyclictest/cyclictest.8 > +++ b/src/cyclictest/cyclictest.8 > @@ -291,6 +291,24 @@ the count, and v is the latency value in microseconds. > .B \\-\-smi > Enable SMI count/detection on processors with SMI count support. > . > +.SH "Example invocation" > +. > +Testing a realtime system is hardware and workload dependent. With that > +in mind, below cyclictest example invocation can provide a good start: > +.PP > +.nf > +.B cyclictest > + --default-system > + --secaligned > + --interval=250 > + --distance=0 > + --mlockall > + --smp > + --priority=98 > + --histogram=1000 > + --histfile=output.txt > +.fi > + > .SH "See also" > .BR numa (3), > .BR numactl (8), > -- > 2.49.0 > > > Signed-off-by: John Kacur <jkacur@xxxxxxxxxx>
