Merge branch 'doc-patches' of https://github.com/vincentkfu/fio
authorJens Axboe <axboe@kernel.dk>
Thu, 14 Sep 2017 17:37:34 +0000 (11:37 -0600)
committerJens Axboe <axboe@kernel.dk>
Thu, 14 Sep 2017 17:37:34 +0000 (11:37 -0600)
1  2 
HOWTO
fio.1

diff --combined HOWTO
--- 1/HOWTO
--- 2/HOWTO
+++ b/HOWTO
@@@ -182,8 -182,10 +182,10 @@@ Command line option
  
  .. option:: --status-interval=time
  
-       Force full status dump every `time` period passed.  When the unit is
-       omitted, the value is interpreted in seconds.
+       Force a full status dump of cumulative (from job start) values at `time`
+       intervals. This option does *not* provide per-period measurements. So
+       values such as bandwidth are running averages. When the time unit is omitted,
+       `time` is interpreted in seconds.
  
  .. option:: --section=name
  
@@@ -2860,15 -2862,7 +2862,15 @@@ Measurements and reportin
  
  .. option:: clat_percentiles=bool
  
 -      Enable the reporting of percentiles of completion latencies.
 +      Enable the reporting of percentiles of completion latencies.  This
 +      option is mutually exclusive with :option:`lat_percentiles`.
 +
 +.. option:: lat_percentiles=bool
 +
 +      Enable the reporting of percentiles of IO latencies. This is similar
 +      to :option:`clat_percentiles`, except that this includes the
 +      submission latency. This option is mutually exclusive with
 +      :option:`clat_percentiles`.
  
  .. option:: percentile_list=float_list
  
@@@ -3389,6 -3383,15 +3391,15 @@@ minimal output v3, separated by semicol
          terse_version_3;fio_version;jobname;groupid;error;read_kb;read_bandwidth;read_iops;read_runtime_ms;read_slat_min;read_slat_max;read_slat_mean;read_slat_dev;read_clat_min;read_clat_max;read_clat_mean;read_clat_dev;read_clat_pct01;read_clat_pct02;read_clat_pct03;read_clat_pct04;read_clat_pct05;read_clat_pct06;read_clat_pct07;read_clat_pct08;read_clat_pct09;read_clat_pct10;read_clat_pct11;read_clat_pct12;read_clat_pct13;read_clat_pct14;read_clat_pct15;read_clat_pct16;read_clat_pct17;read_clat_pct18;read_clat_pct19;read_clat_pct20;read_tlat_min;read_lat_max;read_lat_mean;read_lat_dev;read_bw_min;read_bw_max;read_bw_agg_pct;read_bw_mean;read_bw_dev;write_kb;write_bandwidth;write_iops;write_runtime_ms;write_slat_min;write_slat_max;write_slat_mean;write_slat_dev;write_clat_min;write_clat_max;write_clat_mean;write_clat_dev;write_clat_pct01;write_clat_pct02;write_clat_pct03;write_clat_pct04;write_clat_pct05;write_clat_pct06;write_clat_pct07;write_clat_pct08;write_clat_pct09;write_clat_pct10;write_clat_pct11;write_clat_pct12;write_clat_pct13;write_clat_pct14;write_clat_pct15;write_clat_pct16;write_clat_pct17;write_clat_pct18;write_clat_pct19;write_clat_pct20;write_tlat_min;write_lat_max;write_lat_mean;write_lat_dev;write_bw_min;write_bw_max;write_bw_agg_pct;write_bw_mean;write_bw_dev;cpu_user;cpu_sys;cpu_csw;cpu_mjf;cpu_minf;iodepth_1;iodepth_2;iodepth_4;iodepth_8;iodepth_16;iodepth_32;iodepth_64;lat_2us;lat_4us;lat_10us;lat_20us;lat_50us;lat_100us;lat_250us;lat_500us;lat_750us;lat_1000us;lat_2ms;lat_4ms;lat_10ms;lat_20ms;lat_50ms;lat_100ms;lat_250ms;lat_500ms;lat_750ms;lat_1000ms;lat_2000ms;lat_over_2000ms;disk_name;disk_read_iops;disk_write_iops;disk_read_merges;disk_write_merges;disk_read_ticks;write_ticks;disk_queue_time;disk_util
  
  
+ JSON output
+ ------------
+ The `json` output format is intended to be both human readable and convenient
+ for automated parsing. For the most part its sections mirror those of the
+ `normal` output. The `runtime` value is reported in msec and the `bw` value is
+ reported in 1024 bytes per second units.
  JSON+ output
  ------------
  
diff --combined fio.1
--- 1/fio.1
--- 2/fio.1
+++ b/fio.1
@@@ -84,8 -84,10 +84,10 @@@ Force a new line for every \fItime\fR p
  the value is interpreted in seconds.
  .TP
  .BI \-\-status\-interval \fR=\fPtime
- Force full status dump every \fItime\fR period passed. When the unit is omitted,
- the value is interpreted in seconds.
+ Force a full status dump of cumulative (from job start) values at \fItime\fR
+ intervals. This option does *not* provide per-period measurements. So
+ values such as bandwidth are running averages. When the time unit is omitted,
+ \fItime\fR is interpreted in seconds.
  .TP
  .BI \-\-section \fR=\fPname
  Only run specified section \fIname\fR in job file. Multiple sections can be specified.
@@@ -2543,13 -2545,7 +2545,13 @@@ Disable measurements of throughput/band
  \fBdisable_lat\fR.
  .TP
  .BI clat_percentiles \fR=\fPbool
 -Enable the reporting of percentiles of completion latencies.
 +Enable the reporting of percentiles of completion latencies. This option is
 +mutually exclusive with \fBlat_percentiles\fR.
 +.TP
 +.BI lat_percentiles \fR=\fPbool
 +Enable the reporting of percentiles of IO latencies. This is similar to
 +\fBclat_percentiles\fR, except that this includes the submission latency.
 +This option is mutually exclusive with \fBclat_percentiles\fR.
  .TP
  .BI percentile_list \fR=\fPfloat_list
  Overwrite the default list of percentiles for completion latencies and the
@@@ -3106,6 -3102,12 +3108,12 @@@ minimal output v3, separated by semicol
  .nf
                terse_version_3;fio_version;jobname;groupid;error;read_kb;read_bandwidth;read_iops;read_runtime_ms;read_slat_min;read_slat_max;read_slat_mean;read_slat_dev;read_clat_min;read_clat_max;read_clat_mean;read_clat_dev;read_clat_pct01;read_clat_pct02;read_clat_pct03;read_clat_pct04;read_clat_pct05;read_clat_pct06;read_clat_pct07;read_clat_pct08;read_clat_pct09;read_clat_pct10;read_clat_pct11;read_clat_pct12;read_clat_pct13;read_clat_pct14;read_clat_pct15;read_clat_pct16;read_clat_pct17;read_clat_pct18;read_clat_pct19;read_clat_pct20;read_tlat_min;read_lat_max;read_lat_mean;read_lat_dev;read_bw_min;read_bw_max;read_bw_agg_pct;read_bw_mean;read_bw_dev;write_kb;write_bandwidth;write_iops;write_runtime_ms;write_slat_min;write_slat_max;write_slat_mean;write_slat_dev;write_clat_min;write_clat_max;write_clat_mean;write_clat_dev;write_clat_pct01;write_clat_pct02;write_clat_pct03;write_clat_pct04;write_clat_pct05;write_clat_pct06;write_clat_pct07;write_clat_pct08;write_clat_pct09;write_clat_pct10;write_clat_pct11;write_clat_pct12;write_clat_pct13;write_clat_pct14;write_clat_pct15;write_clat_pct16;write_clat_pct17;write_clat_pct18;write_clat_pct19;write_clat_pct20;write_tlat_min;write_lat_max;write_lat_mean;write_lat_dev;write_bw_min;write_bw_max;write_bw_agg_pct;write_bw_mean;write_bw_dev;cpu_user;cpu_sys;cpu_csw;cpu_mjf;cpu_minf;iodepth_1;iodepth_2;iodepth_4;iodepth_8;iodepth_16;iodepth_32;iodepth_64;lat_2us;lat_4us;lat_10us;lat_20us;lat_50us;lat_100us;lat_250us;lat_500us;lat_750us;lat_1000us;lat_2ms;lat_4ms;lat_10ms;lat_20ms;lat_50ms;lat_100ms;lat_250ms;lat_500ms;lat_750ms;lat_1000ms;lat_2000ms;lat_over_2000ms;disk_name;disk_read_iops;disk_write_iops;disk_read_merges;disk_write_merges;disk_read_ticks;write_ticks;disk_queue_time;disk_util
  .fi
+ .SH JSON OUTPUT
+ The \fBjson\fR output format is intended to be both human readable and convenient
+ for automated parsing. For the most part its sections mirror those of the
+ \fBnormal\fR output. The \fBruntime\fR value is reported in msec and the \fBbw\fR value is
+ reported in 1024 bytes per second units.
+ .fi
  .SH JSON+ OUTPUT
  The \fBjson+\fR output format is identical to the \fBjson\fR output format except that it
  adds a full dump of the completion latency bins. Each \fBbins\fR object contains a