docs: clean up steadystate options

Synchronize HOWTO.rst and fio.1, make a minor edit, and improve the
formatting.

Signed-off-by: Vincent Fu <vincent.fu@samsung.com>

diff --git a/HOWTO.rst b/HOWTO.rst
index bc9693888c95d364faf85dadb15ef0ed662d7c6f..5240f9da866d76da6d044961585d3b6249b3d514 100644 (file)
--- a/HOWTO.rst
+++ b/HOWTO.rst
@@ -3821,10 +3821,11 @@ Steady state
 
 .. option:: steadystate_duration=time, ss_dur=time
 
-       A rolling window of this duration will be used to judge whether steady state
-       has been reached. Data will be collected every ss_check_interval.
-       The default is 0 which disables steady state detection.  When the unit is omitted,
-       the value is interpreted in seconds.
+        A rolling window of this duration will be used to judge whether steady
+        state has been reached. Data will be collected every
+        :option:`ss_interval`.  The default is 0 which disables steady state
+        detection.  When the unit is omitted, the value is interpreted in
+        seconds.
 
 .. option:: steadystate_ramp_time=time, ss_ramp=time
 
@@ -3834,11 +3835,11 @@ Steady state
 
 .. option:: steadystate_check_interval=time, ss_interval=time
 
-       The values during the rolling window will be collected with a period
-       of this value. If ss_interval is 30s and ss_dur is 300s, 10 measurements will
-       be taken. Default is 1s but that might not converge, especially for
-       slower cards, so set this accordingly. When the unit is omitted,
-       the value is interpreted in seconds.
+        The values during the rolling window will be collected with a period of
+        this value. If :option:`ss_interval` is 30s and :option:`ss_dur` is
+        300s, 10 measurements will be taken. Default is 1s but that might not
+        converge, especially for slower devices, so set this accordingly. When
+        the unit is omitted, the value is interpreted in seconds.
 
 
 Measurements and reporting

diff --git a/fio.1 b/fio.1
index af588077bb63d027062e6fcb91b5fb2585d4a3e6..e2db3a3fc0385ecb934b04cd739834af90a728ef 100644 (file)
--- a/fio.1
+++ b/fio.1
@@ -3532,9 +3532,9 @@ slope. Stop the job if the slope falls below the specified limit.
 .TP
 .BI steadystate_duration \fR=\fPtime "\fR,\fP ss_dur" \fR=\fPtime
 A rolling window of this duration will be used to judge whether steady state
-has been reached. Data will be collected once per second. The default is 0
-which disables steady state detection. When the unit is omitted, the
-value is interpreted in seconds.
+has been reached. Data will be collected every \fBss_interval\fR. The default
+is 0 which disables steady state detection. When the unit is omitted, the value
+is interpreted in seconds.
 .TP
 .BI steadystate_ramp_time \fR=\fPtime "\fR,\fP ss_ramp" \fR=\fPtime
 Allow the job to run for the specified duration before beginning data
@@ -3543,9 +3543,10 @@ default is 0. When the unit is omitted, the value is interpreted in seconds.
 .TP
 .BI steadystate_check_interval \fR=\fPtime "\fR,\fP ss_interval" \fR=\fPtime
 The values suring the rolling window will be collected with a period of this
-value. Default is 1s but that might not converge, especially for slower cards,
-so set this accordingly. When the unit is omitted, the value is interpreted
-in seconds.
+value. If \fBss_interval\fR is 30s and \fBss_dur\fR is 300s, 10 measurements
+will be taken. Default is 1s but that might not converge, especially for slower
+devices, so set this accordingly. When the unit is omitted, the value is
+interpreted in seconds.
 .SS "Measurements and reporting"
 .TP
 .BI per_job_logs \fR=\fPbool