[PATCH] Change timeout to runtime and rearrange option entries

[fio.git] / HOWTO

diff --git a/HOWTO b/HOWTO
index 19182019f7020389e6e5e48391e8f2b6f58b5871..57c0730b13d0ef7ef8b257a97ff56c1181aa53cf 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -211,6 +211,9 @@ rw=str              Type of io pattern. Accepted values are:
                For certain types of io the result may still be skewed a bit,
                since the speed may be different.
 
+randrepeat=bool        For random IO workloads, seed the generator in a predictable
+               way so that results are repeatable across repetitions.
+
 size=siint     The total size of file io for this job. This may describe
                the size of the single file the job uses, or it may be
                divided between the number of files in the job. If the
@@ -319,7 +322,13 @@ prioclass=int      Set the io priority class. See man ionice(1).
 
 thinktime=int  Stall the job x microseconds after an io has completed before
                issuing the next. May be used to simulate processing being
-               done by an application.
+               done by an application. See thinktime_blocks.
+
+thinktime_blocks
+               Only valid if thinktime is set - control how many blocks
+               to issue, before waiting 'thinktime' usecs. If not set,
+               defaults to 1 which will make fio wait 'thinktime' usecs
+               after every block.
 
 rate=int       Cap the bandwidth used by this job to this number of KiB/sec.
 
@@ -338,7 +347,7 @@ startdelay=int      Start this job the specified number of seconds after fio
                jobs, and you want to delay starting some jobs to a certain
                time.
 
-timeout=int    Tell fio to terminate processing after the specified number
+runtime=int    Tell fio to terminate processing after the specified number
                of seconds. 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.
@@ -408,7 +417,7 @@ create_serialize=bool       If true, serialize the file creating for the jobs.
 create_fsync=bool      fsync the data file after creation. This is the
                        default.
 
-unlink         Unlink the job files when done. fio defaults to doing this,
+unlink=bool    Unlink the job files when done. fio defaults to doing this,
                if it created the file itself.
 
 loops=int      Run the specified number of iterations of this job. Used