rteval: Edited documentation for multistressor support
PATCH 1/1 rteval: Edited documentation for multistressor support
Edited docs/rteval.8 to agree with recent code changes in stress-ng load module. This is specfically focused on the multistressor support changes.
Assisted-by Claude Opus 4.8
Signed-off-by Sana Sharma <[email protected]>
--- doc/rteval.8 | 35 +++++++++++++++++++++++++++++++---- 1 file changed, 31 insertions(+), 4 deletions(-)
doc/rteval.8 +31 -4
@@ -160,12 +160,21 @@ Source tar ball (default: linux-6.17.7.tar.xz). Number of working threads per core (default: 2). .SS Stress-ng Load Module Options +The stress-ng load module only runs when at least one stressor is specified via +\fB\-\-stressng\-stressor\fR or \fB\-\-stressng\-stressors\fR. When it runs, it +takes over as the exclusive load module (other load modules are not run). +Stressor names are validated against the output of \fBstress\-ng \-\-stressors\fR. .TP -.B \-\-stressng\-option \fIOPTION\fR -Stressor specific option. +.B \-\-stressng\-stressor \fINAME\fR +Stressor to run. Repeat the flag to run several stressors in parallel +(e.g., \fB\-\-stressng\-stressor cpu \-\-stressng\-stressor vm\fR). .TP -.B \-\-stressng\-arg \fIARG\fR -Stressor specific arg. +.B \-\-stressng\-stressors \fILIST\fR +Comma-separated list of stressors to run in parallel (e.g., \fIcpu,vm,io\fR). +.TP +.B \-\-stressng\-workers \fIN\fR +Number of workers to start per stressor (default: 0, which starts one worker per +available CPU). .TP .B \-\-stressng\-timeout \fIT\fR Timeout after T seconds.
@@ -238,6 +247,24 @@ sudo rteval -d 1800 --measurement-module timerlat \\ .RE .fi +.SS Multiple Stress-ng Stressors +Run several stress-ng stressors in parallel as the system load: +.PP +.nf +.RS +sudo rteval -d 3600 \\ + --stressng-stressor cpu --stressng-stressor vm +.RE +.fi +.PP +The same set of stressors can be given as a comma-separated list: +.PP +.nf +.RS +sudo rteval -d 3600 --stressng-stressors cpu,vm,io +.RE +.fi + .SS Analyze Existing Reports Summarize multiple existing XML reports: .PP
Signature · 5 lines
2.54.0 -- Sana Sharma <[email protected]>
Quoted 1 line · Sana Sharma
[PATCH v1] rteval: Edited documentation for multistressor support
Looks good - thanks for dropping the stale --stressng-option / --stressng-arg entries and documenting the new flags. The content matches the actual behaviour (workers default 0 = one per CPU).
Two tiny fixes for a v2:
- the commit message says "docs/rteval.8"; the path is "doc/rteval.8".
- typo: "specfically" -> "specifically".
John