Fix man page documentation for verify_pattern
authorJens Axboe <jaxboe@fusionio.com>
Thu, 24 Jun 2010 06:37:13 +0000 (08:37 +0200)
committerJens Axboe <jaxboe@fusionio.com>
Thu, 24 Jun 2010 06:37:13 +0000 (08:37 +0200)
Signed-off-by: Jens Axboe <jaxboe@fusionio.com>
HOWTO
fio.1

diff --git a/HOWTO b/HOWTO
index cafe1893656cfdff733c9b4368a92396ce9bd46c..3af4ce6b9e75b89a3089c509281f241f5a836baa 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -849,7 +849,7 @@ verify=str  If writing to a file, fio can verify the file contents
 
                        meta    Write extra information about each io
                                (timestamp, block number etc.). The block
-                               number is verified.
+                               number is verified. See also verify_pattern.
 
                        null    Only pretend to verify. Useful for testing
                                internals with ioengine=null, not for much
@@ -887,7 +887,8 @@ verify_pattern=str  If set, fio will fill the io buffers with this
                width of the pattern, fio will fill 1/2/3/4 bytes of the
                buffer at the time(it can be either a decimal or a hex number).
                The verify_pattern if larger than a 32-bit quantity has to
-               be a hex number that starts with either "0x" or "0X".
+               be a hex number that starts with either "0x" or "0X". Use
+               with verify=meta.
 
 verify_fatal=bool      Normally fio will keep checking the entire contents
                before quitting on a block verification failure. If this
diff --git a/fio.1 b/fio.1
index b94241d48c2efc5081b058ce8de464e51e357031..0e6095d6499b1f33e8cd1937a17ecbdd2fa548b5 100644 (file)
--- a/fio.1
+++ b/fio.1
@@ -612,13 +612,7 @@ not supported by the system.
 .TP
 .B meta
 Write extra information about each I/O (timestamp, block number, etc.). The
-block number is verified.
-.TP
-.B pattern
-Fill I/O buffers with a specific pattern that is used to verify. If the pattern
-is < 4bytes, it can either be a decimal or a hexadecimal number. If the pattern
-is > 4bytes, currently, it can only be a hexadecimal pattern starting with
-either "0x" or "0X".
+block number is verified. See \fBverify_pattern\fR as well.
 .TP
 .B null
 Pretend to verify.  Used for testing internals.
@@ -643,6 +637,15 @@ writing.  It is swapped back before verifying.
 Write the verification header for this number of bytes, which should divide
 \fBblocksize\fR.  Default: \fBblocksize\fR.
 .TP
+.BI verify_pattern \fR=\fPstr
+If set, fio will fill the io buffers with this pattern. Fio defaults to filling
+with totally random bytes, but sometimes it's interesting to fill with a known
+pattern for io verification purposes. Depending on the width of the pattern,
+fio will fill 1/2/3/4 bytes of the buffer at the time(it can be either a
+decimal or a hex number). The verify_pattern if larger than a 32-bit quantity
+has to be a hex number that starts with either "0x" or "0X". Use with
+\fBverify\fP=meta.
+.TP
 .BI verify_fatal \fR=\fPbool
 If true, exit the job on the first observed verification failure.  Default:
 false.