Updated rteval man page

The rteval man page should reflect the functionality of the
current iteration of rteval. Currently the rteval man page
reflects the functionality of an outdated version. This patch
removes deprecated options and adds options that have been
added in recent updates.

Signed-off-by: Anubhav Shelat <ashelat@redhat.com>
---
 doc/rteval.8 | 50 +++++++++++++++++++++++++++++++++-----------------
 1 file changed, 33 insertions(+), 17 deletions(-)

On Wed, 5 Jun 2024, Anubhav Shelat wrote:

> The rteval man page should reflect the functionality of the
> current iteration of rteval. Currently the rteval man page
> reflects the functionality of an outdated version. This patch
> removes deprecated options and adds options that have been
> added in recent updates.
> 
> Signed-off-by: Anubhav Shelat <ashelat@redhat.com>
> ---
>  doc/rteval.8 | 50 +++++++++++++++++++++++++++++++++-----------------
>  1 file changed, 33 insertions(+), 17 deletions(-)
> 
> diff --git a/doc/rteval.8 b/doc/rteval.8
> index 578de370effa..264bf5207716 100644
> --- a/doc/rteval.8
> +++ b/doc/rteval.8
> @@ -63,6 +63,9 @@ for example to execute a ten minute run of rteval:
>  .B \-v, \-\-verbose
>  Increase the verbosity of output during the test run
>  .TP
> +.B \-q, \-\-quiet
> +Set rteval to run in quiet mode.
> +.TP
>  .B \-w WORKDIR, \-\-workdir=WORKDIR
>  Tell rteval to change directory to WORKDIR before creating any
>  subdirectories for report files. The default WORKDIR is the directory
> @@ -71,11 +74,8 @@ in which rteval was started.
>  .B \-l LOADDIR, \-\-loaddir=LOADDIR
>  Tell rteval where to find the source for the loads
>  .TP
> -.B \-\-loads\-cpulist=CPULIST
> -List of CPUs where loads will run
> -.TP
> -.B \-\-measurement-cpulist=CPULIST
> -List of CPUs where measurement applciation will run
> +.B \-i INSTALLDIR, \-\-installdir=INSTALLDIR
> +Tell rteval where to locate installed templates.
>  .TP
>  .B \-s, \-\-sysreport
>  Have rteval run the sysreport utility after a run to gather
> @@ -103,11 +103,25 @@ Log the output of the loads in the report directory
>  .B \-O, \-\-onlyload
>  Only run the loads (don't run measurement threads)
>  .TP
> +.B \-V, \-\-version 
> +Print rteval version and exit.
> +.TP
>  .B \-S KERNEL_VERSION, \-\-source\-download=KERNEL_VERSION
>  download a source kernel from kernel.org and exit
>  
> +.SH GROUP OPTIONS
> +.TP
> +.B \-\-loads\-cpulist=CPULIST
> +List of CPUs where loads will run
> +.TP
> +.B \-\-measurement-cpulist=CPULIST
> +List of CPUs where measurement applciation will run
> +.TP
> +.B \-\-measurement-run-on-isolcpus
> +Include isolated CPUs in default cpulist
> +
>  
> -.SH MODULE OPTIONS
> +.SH CYCLICTEST OPTIONS
>  These are options that affect the execution behavior of the measurement and load modules.
>  .TP
>  .B \-\-cyclictest-priority=PRIORITY
> @@ -116,21 +130,23 @@ SCHED_FIFO priority for measurement threads (default: 95)
>  .B \-\-cyclictest-interval=INTERVAL
>  Measurement thread interval in microseconds (default: 100)
>  .TP
> -.B \-\-cyclictest-distance=DISTANCE
> -Interval increment in microseconds (default: 0)
> -.TP
>  .B \-\-cyclictest-buckets=NBUCKETS
>  Number of 1 microsecond histogram buckets (default: 3500)
>  .TP
> -.B \-\-hackbench-jobspercore=N
> -Number of jobs per online-core for hackbench load
> +.B \-\-cyclictest-breaktrace=USEC
> +Send a break trace command if latency exceeds the given number of microseconds.
> +.TP
> +.B \-\-cyclictest-threshold=USEC
> +Exit rteval if latency exceeds the given number of microseconds.
> +.TP
> +.B \-\-stressng-option=OPTION
> +Pass in command line options for the stress-ng package.
> +.TP
> +.B \-\-stressng-arg=ARG
> +Pass in command line arguments for the stress-ng package.
>  .TP
> -.B \-\-kcompile-jobspercore=N
> -Number of jobs per online-core for kernel compile load
> -.\" .SH SEE ALSO
> -.\" .BR bar (1),
> -.\" .BR baz (1).
> -.\" .br
> +.B \-\-stressng-timeout=T 
> +Timeout after T seconds.
>  
>  .SH FILES
>  .BR rteval-YYYYMMDD-S
> -- 
    - Changed spelling from "applciation" to "application"
    - Removed some white space at the end of two lines
    Signed-off-by: John Kacur <jkacur@redhat.com>

On Wed, 2024-06-05 at 14:24 -0400, Anubhav Shelat wrote:

>  
> -.SH MODULE OPTIONS
> +.SH CYCLICTEST OPTIONS
>  These are options that affect the execution behavior of the measurement
> and load modules.

Why is this section called "cyclictest options" when there are stressng
options in it?

-Crystal