From: Vincent Fu Date: Wed, 30 Aug 2017 19:42:52 +0000 (-0400) Subject: doc: provide more detail regarding the --status-interval option X-Git-Tag: fio-3.1~7^2~1 X-Git-Url: https://git.kernel.dk/?p=fio.git;a=commitdiff_plain;h=aa6cb4598cfde5a1c3f58e39160a2b2b99369625 doc: provide more detail regarding the --status-interval option There has been some confusion regarding what the --status-interval option provides. Modify the HOWTO and man page to emphasize that --status-interval provides cumulative instead of per-period values. --- diff --git a/HOWTO b/HOWTO index 2a70b7c6..34386daa 100644 --- a/HOWTO +++ b/HOWTO @@ -182,8 +182,10 @@ Command line options .. option:: --status-interval=time - Force full status dump every `time` period passed. When the unit is - omitted, the value is interpreted in seconds. + Force a full status dump of cumulative (from job start) values at `time` + intervals. This option does *not* provide per-period measurements. So + values such as bandwidth are running averages. When the time unit is omitted, + `time` is interpreted in seconds. .. option:: --section=name diff --git a/fio.1 b/fio.1 index 97133dac..091bc1b9 100644 --- a/fio.1 +++ b/fio.1 @@ -84,8 +84,10 @@ Force a new line for every \fItime\fR period passed. When the unit is omitted, the value is interpreted in seconds. .TP .BI \-\-status\-interval \fR=\fPtime -Force full status dump every \fItime\fR period passed. When the unit is omitted, -the value is interpreted in seconds. +Force a full status dump of cumulative (from job start) values at \fItime\fR +intervals. This option does *not* provide per-period measurements. So +values such as bandwidth are running averages. When the time unit is omitted, +\fItime\fR is interpreted in seconds. .TP .BI \-\-section \fR=\fPname Only run specified section \fIname\fR in job file. Multiple sections can be specified.