From 1cb049d945600c0bcbb882b95afab9ac607e5613 Mon Sep 17 00:00:00 2001 From: Vincent Fu Date: Fri, 21 Sep 2018 11:37:17 -0400 Subject: [PATCH] docs: clarify usage of steadystate detection feature Note that most intended uses of the steadystate detection feature likely also need the --time_based and --runtime options or the --loops option so that fio does not stop running after accessing the full size of the device(s) or file(s). --- HOWTO | 4 ++++ fio.1 | 6 ++++++ 2 files changed, 10 insertions(+) diff --git a/HOWTO b/HOWTO index 45cf0bdf..95289040 100644 --- a/HOWTO +++ b/HOWTO @@ -3000,6 +3000,10 @@ Steady state data from the rolling collection window. Threshold limits can be expressed as a fixed value or as a percentage of the mean in the collection window. + When using this feature, most jobs should include the :option:`time_based` + and :option:`runtime` options or the :option:`loops` option so that fio does not + stop running after it has covered the full size of the specified file(s) or device(s). + **iops** Collect IOPS data. Stop the job if all individual IOPS measurements are within the specified limit of the mean IOPS (e.g., ``iops:2`` diff --git a/fio.1 b/fio.1 index 81164ae0..5c11d963 100644 --- a/fio.1 +++ b/fio.1 @@ -2671,6 +2671,12 @@ steady state assessment criteria. All assessments are carried out using only data from the rolling collection window. Threshold limits can be expressed as a fixed value or as a percentage of the mean in the collection window. .RS +.P +When using this feature, most jobs should include the \fBtime_based\fR +and \fBruntime\fR options or the \fBloops\fR option so that fio does not +stop running after it has covered the full size of the specified file(s) +or device(s). +.RS .RS .TP .B iops -- 2.25.1