Update rteval man page
Resolves: RHEL-37635 Signed-off-by: Anubhav Shelat <ashelat@redhat.com>
This commit is contained in:
Anubhav Shelat
parent
94da2e4b46
commit
7450e72fa6
109
0001-Updated-rteval-man-page.patch
Normal file
109
0001-Updated-rteval-man-page.patch
Normal file
@ -0,0 +1,109 @@
|
||||
From 66b6c5851ea2241b6e368a1538dc10fd1f3f76f7 Mon Sep 17 00:00:00 2001
|
||||
From: Anubhav Shelat <ashelat@redhat.com>
|
||||
Date: Wed, 5 Jun 2024 14:04:54 -0400
|
||||
Subject: [PATCH] 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(-)
|
||||
|
||||
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
|
||||
--
|
||||
2.45.1
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
Name: rteval
|
||||
Version: 3.8
|
||||
Release: 2%{?dist}
|
||||
Release: 3%{?dist}
|
||||
Summary: Utility to evaluate system suitability for RT Linux
|
||||
|
||||
Group: Development/Tools
|
||||
@ -33,6 +33,7 @@ Requires: procps-ng
|
||||
BuildArch: noarch
|
||||
|
||||
# Patches
|
||||
Patch1: 0001-Updated-rteval-man-page.patch
|
||||
|
||||
%description
|
||||
The rteval script is a utility for measuring various aspects of
|
||||
@ -45,6 +46,7 @@ to the screen.
|
||||
|
||||
%prep
|
||||
%setup -q
|
||||
%patch1 -p1
|
||||
|
||||
%build
|
||||
%{__python3} setup.py build
|
||||
@ -65,6 +67,10 @@ to the screen.
|
||||
%{_bindir}/rteval
|
||||
|
||||
%changelog
|
||||
* Thu Jun 7 2024 Anubhav Shelat <ashelat@redhat.com> - 3.8-3
|
||||
- Update rteval man page
|
||||
Resolves: RHEL-37635
|
||||
|
||||
* Wed May 29 2024 Tomas Glozar <tglozar@redhat.com> - 3.8-2
|
||||
- Add dependency on procps-ng which was missing in minimal environments
|
||||
Resolves: RHEL-38379
|
||||
|
||||
Loading…
Reference in New Issue
Block a user