From 589e88b7d96e8ea18f3257558fd1e00d320cef7d Mon Sep 17 00:00:00 2001 From: Tomohiro Kusumi Date: Mon, 7 Aug 2017 20:37:53 +0300 Subject: [PATCH] HOWTO: use proper (or drop wrong usage of) option type =bool There are options whose .type field are FIO_OPT_BOOL, but not using =bool for arg type. Likewise there are options whose .type field are not FIO_OPT_BOOL, but using =bool for arg type. The options without explicit arg types in HOWTO seem to be for FIO_OPT_STR_SET, which is not the same as FIO_OPT_BOOL. The man page also has these, but not the same as the ones in HOWTO. Also fix a typo "(mtd)skipbad=bool" in the man page which should be "(mtd)skip_bad=bool". Signed-off-by: Tomohiro Kusumi Signed-off-by: Jens Axboe --- HOWTO | 8 ++++---- fio.1 | 10 +++++----- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/HOWTO b/HOWTO index cad95009..b535177c 100644 --- a/HOWTO +++ b/HOWTO @@ -1392,7 +1392,7 @@ Block size typically won't work with direct I/O, as that normally requires sector alignment. -.. option:: bs_is_seq_rand +.. option:: bs_is_seq_rand=bool If this option is set, fio will use the normal read,write blocksize settings as sequential,random blocksize settings instead. Any random read or write @@ -2166,7 +2166,7 @@ I/O replay replay, the file needs to be turned into a blkparse binary data file first (``blkparse -o /dev/null -d file_for_fio.bin``). -.. option:: replay_no_stall=int +.. option:: replay_no_stall=bool When replaying I/O with :option:`read_iolog` the default behavior is to attempt to respect the timestamps within the log and replay them with the @@ -2680,7 +2680,7 @@ Measurements and reporting all jobs in a file will be part of the same reporting group, unless separated by a :option:`stonewall`. -.. option:: stats +.. option:: stats=bool By default, fio collects and shows final output results for all jobs that run. If this option is set to 0, then fio will ignore it in @@ -2763,7 +2763,7 @@ Measurements and reporting you instead want to log the maximum value, set this option to 1. Defaults to 0, meaning that averaged values are logged. -.. option:: log_offset=int +.. option:: log_offset=bool If this is set, the iolog options will include the byte offset for the I/O entry as well as the other data values. Defaults to 0 meaning that diff --git a/fio.1 b/fio.1 index 2919686e..093889ed 100644 --- a/fio.1 +++ b/fio.1 @@ -1510,7 +1510,7 @@ Should be a multiple of 1MiB. Default: 4MiB. .B exitall Terminate all jobs when one finishes. Default: wait for each job to finish. .TP -.B exitall_on_error \fR=\fPbool +.B exitall_on_error Terminate all jobs if one job finishes in error. Default: wait for each job to finish. .TP @@ -1566,7 +1566,7 @@ Unlink job files after each iteration or loop. Default: false. Specifies the number of iterations (runs of the same workload) of this job. Default: 1. .TP -.BI verify_only \fR=\fPbool +.BI verify_only Do not perform the specified workload, only verify data still matches previous invocation of this workload. This option allows one to check data multiple times at a later date without overwriting it. This option makes sense only for @@ -1756,7 +1756,7 @@ corrupt. Replay the I/O patterns contained in the specified file generated by \fBwrite_iolog\fR, or may be a \fBblktrace\fR binary file. .TP -.BI replay_no_stall \fR=\fPint +.BI replay_no_stall \fR=\fPbool While replaying I/O patterns using \fBread_iolog\fR the default behavior attempts to respect timing information between I/Os. Enabling \fBreplay_no_stall\fR causes I/Os to be replayed as fast as possible while @@ -2120,7 +2120,7 @@ For TCP network connections, tell fio to listen for incoming connections rather than initiating an outgoing connection. The hostname must be omitted if this option is used. .TP -.BI (net,netsplice)pingpong \fR=\fPbool +.BI (net,netsplice)pingpong Normally a network writer will just continue writing data, and a network reader will just consume packets. If pingpong=1 is set, a writer will send its normal payload to the reader, then wait for the reader to send the same payload back. @@ -2163,7 +2163,7 @@ Specifies the username (without the 'client.' prefix) used to access the Ceph cluster. If the clustername is specified, the clientname shall be the full type.id string. If no type. prefix is given, fio will add 'client.' by default. .TP -.BI (mtd)skipbad \fR=\fPbool +.BI (mtd)skip_bad \fR=\fPbool Skip operations against known bad blocks. .SH OUTPUT While running, \fBfio\fR will display the status of the created jobs. For -- 2.25.1