[PATCH] fio: more documentation updates

diff --git a/README.fio b/README.fio
index 66ac18da169843bf8a7869827a62d17aeb1d5dab..db06986b4b775ebdb4a1bc72737e5b089684b650 100644 (file)
--- a/README.fio
+++ b/README.fio
@@ -24,38 +24,39 @@ The <jobs> format is as follows:
 
        directory=x     Use 'x' as the top level directory for storing files
        rw=x            'x' may be: read, randread, write, or randwrite
+       size=x          Set file size to x bytes (x string can include k/m/g)
        ioengine=x      'x' may be: aio/libaio for Linux aio, posixaio for
                        POSIX aio, sync for regular read/write io, or
                        mmap for mmap'ed io.
+       iodepth=x       For async io, allow 'x' ios in flight
        overwrite=x     If 'x', layout a write file first.
        prio=x          Run io at prio X, 0-7 is the kernel allowed range
        prioclass=x     Run io at prio class X
-       file=foo        Do the io to file foo
-       bs=x            Thread blocksize is x bytes
-       bsrange=x-y     Mix thread block sizes randomly between x and y
+       bs=x            Use 'x' for thread blocksize. May include k/m postfix.
+       bsrange=x-y     Mix thread block sizes randomly between x and y. May
+                       also include k/m postfix.
        direct=x        1 for direct IO, 0 for buffered IO
        thinktime=x     "Think" x usec after each io
        rate=x          Throttle rate to x KiB/sec
        ratemin=x       Quit if rate of x KiB/sec can't be met
        ratecycle=x     ratemin averaged over x msecs
-       cpumask=x       Allow job to run on CPUs defined by mask
+       cpumask=x       Only allow job to run on CPUs defined by mask.
        fsync=x         If writing, fsync after every x blocks have been written
        startdelay=x    Start this thread x seconds after startup
        timeout=x       Terminate x seconds after startup
-       iodepth=x       For async io, allow 'x' ios in flight
-       size=x          Set file size to x bytes (x string can include k/m/g)
        offset=x        Start io at offset x (x string can include k/m/g)
        invalidate=x    Invalidate page cache for file prior to doing io
        sync=x          Use sync writes if x and writing
        mem=x           If x == malloc, use malloc for buffers. If x == shm,
                        use shm for buffers. If x == mmap, use anon mmap.
        exitall         When one thread quits, terminate the others
-       bwavgtime=x     Average bandwidth stats over x msec
+       bwavgtime=x     Average bandwidth stats over an x msec window.
        create_serialize=x      If 'x', serialize file creation.
        create_fsync=x  If 'x', run fsync() after file creation.
        loops=x         Run the job 'x' number of times.
        verify=x        If 'x' == md5, use md5 for verifies. If 'x' == crc32,
-                       use crc32 for verifies.
+                       use crc32 for verifies. md5 is 'safer', but crc32 is
+                       a lot faster. Only makes sense for writing to a file.
        stonewall       Wait for preceeding jobs to end before running.
        numjobs=x       Create 'x' similar entries for this job
        thread          Use pthreads instead of forked jobs