Add pre_read option

[fio.git] / HOWTO

diff --git a/HOWTO b/HOWTO
index 15f576d28fa2ff16038c6249d41da6d2f4d64357..1390f386adca52a4c4ccdec3d60c6c730b9392e5 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -230,7 +230,7 @@ description=str     Text description of the job. Doesn't do anything except
                dump this text description when this job is run. It's
                not parsed.
 
-directory=str  Prefix filenames with this directory. Used to places files
+directory=str  Prefix filenames with this directory. Used to place files
                in a different location than "./".
 
 filename=str   Fio normally makes up a filename based on the job name,
@@ -250,7 +250,7 @@ filename=str        Fio normally makes up a filename based on the job name,
 opendir=str    Tell fio to recursively add any file it can find in this
                directory and down the file system tree.
 
-lockfile=str   Fio defaults to not doing any locking files before it does
+lockfile=str   Fio defaults to not locking any files before it does
                IO to them. If a file or file descriptor is shared, fio
                can serialize IO to that file to make the end result
                consistent. This is usual for emulating real workloads that
@@ -303,7 +303,7 @@ fadvise_hint=bool By default, fio will use fadvise() to advise the kernel
 size=int       The total size of file io for this job. Fio will run until
                this many bytes has been transferred, unless runtime is
                limited by other options (such as 'runtime', for instance).
-               Unless specific nr_files and filesize options are given,
+               Unless specific nrfiles and filesize options are given,
                fio will divide this size between the available files
                specified by the job.
 
@@ -713,6 +713,9 @@ create_fsync=bool   fsync the data file after creation. This is the
 create_on_open=bool    Don't pre-setup the files for IO, just create open()
                        when it's time to do IO to that file.
 
+pre_read=bool  If this is given, files will be pre-read into memory before
+               starting the given IO operation.
+
 unlink=bool    Unlink the job files when done. Not the default, as repeated
                runs of that job would then waste time recreating the file
                set again and again.
@@ -874,7 +877,7 @@ cpuload=int If the job is a CPU cycle eater, attempt to use the specified
                percentage of CPU cycles.
 
 cpuchunks=int  If the job is a CPU cycle eater, split the load into
-               cycles of the given time. In milliseconds.
+               cycles of the given time. In microseconds.
 
 disk_util=bool Generate disk utilization statistics, if the platform
                supports it. Defaults to on.
@@ -935,7 +938,7 @@ I           Thread initialized, waiting.
        M       Running, doing mixed sequential reads/writes.
        m       Running, doing mixed random reads/writes.
        F       Running, currently waiting for fsync()
-V              Running, doing verification of written data.
+       V       Running, doing verification of written data.
 E              Thread exited, not reaped by main thread yet.
 _              Thread reaped.