From c7927863619e86e9872b9b5d31eab4a0a23786dd Mon Sep 17 00:00:00 2001 From: Horshack Date: Fri, 10 Feb 2023 14:00:11 -0500 Subject: [PATCH] Clarify documentation for runtime parameter I realize this is highly subjective but I think the description of the runtime parameter could be made a bit more precise. I misinterpreted its meaning after reading the doc and only learned of my mistake by trial and error using fio. Either I'm just slow or the description could use just a little more precision :) Signed-off-by: Adam Horshack (horshack@live.com) --- HOWTO.rst | 10 ++++++---- fio.1 | 10 ++++++---- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/HOWTO.rst b/HOWTO.rst index 17caaf5d..0ccf03e2 100644 --- a/HOWTO.rst +++ b/HOWTO.rst @@ -686,10 +686,12 @@ Time related parameters .. option:: runtime=time - Tell fio to terminate processing after the specified period of time. It - can be quite hard to determine for how long a specified job will run, so - this parameter is handy to cap the total runtime to a given time. When - the unit is omitted, the value is interpreted in seconds. + Limit runtime. The test will run until it completes the configured I/O + workload or until it has run for this specified amount of time, whichever + occurs first. It can be quite hard to determine for how long a specified + job will run, so this parameter is handy to cap the total runtime to a + given time. When the unit is omitted, the value is interpreted in + seconds. .. option:: time_based diff --git a/fio.1 b/fio.1 index 527b3d46..614ad902 100644 --- a/fio.1 +++ b/fio.1 @@ -471,10 +471,12 @@ See \fB\-\-max\-jobs\fR. Default: 1. .SS "Time related parameters" .TP .BI runtime \fR=\fPtime -Tell fio to terminate processing after the specified period of time. It -can be quite hard to determine for how long a specified job will run, so -this parameter is handy to cap the total runtime to a given time. When -the unit is omitted, the value is interpreted in seconds. +Limit runtime. The test will run until it completes the configured I/O +workload or until it has run for this specified amount of time, whichever +occurs first. It can be quite hard to determine for how long a specified +job will run, so this parameter is handy to cap the total runtime to a +given time. When the unit is omitted, the value is interpreted in +seconds. .TP .BI time_based If set, fio will run for the duration of the \fBruntime\fR specified -- 2.25.1