HOWTO: fix up broken formatting in logging options

[fio.git] / HOWTO

diff --git a/HOWTO b/HOWTO
index dce96bcd8103f075d56b21173659f3061f6600b1..70f937245b667553607b15bd65ff9ec9e6931d06 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -2748,8 +2748,8 @@ Measurements and reporting
 .. option:: write_lat_log=str
 
        Same as :option:`write_bw_log`, except this option creates I/O
-       submission (e.g., `file:`name_slat.x.log`), completion (e.g.,
-       `file:`name_clat.x.log`), and total (e.g., `file:`name_lat.x.log`)
+       submission (e.g., :file:`name_slat.x.log`), completion (e.g.,
+       :file:`name_clat.x.log`), and total (e.g., :file:`name_lat.x.log`)
        latency files instead. See :option:`write_bw_log` for details about
        the filename format and `Log File Formats`_ for how data is structured
        within the files.
@@ -2757,7 +2757,7 @@ Measurements and reporting
 .. option:: write_hist_log=str
 
        Same as :option:`write_bw_log` but writes an I/O completion latency
-       histogram file (e.g., `file:`name_hist.x.log`) instead. Note that this
+       histogram file (e.g., :file:`name_hist.x.log`) instead. Note that this
        file will be empty unless :option:`log_hist_msec` has also been set.
        See :option:`write_bw_log` for details about the filename format and
        `Log File Formats`_ for how data is structured within the file.
@@ -2765,7 +2765,7 @@ Measurements and reporting
 .. option:: write_iops_log=str
 
        Same as :option:`write_bw_log`, but writes an IOPS file (e.g.
-       `file:`name_iops.x.log`) instead. See :option:`write_bw_log` for
+       :file:`name_iops.x.log`) instead. See :option:`write_bw_log` for
        details about the filename format and `Log File Formats`_ for how data
        is structured within the file.
 
@@ -2909,6 +2909,13 @@ Measurements and reporting
        completion latency below which 99.5% and 99.9% of the observed latencies
        fell, respectively.
 
+.. option:: significant_figures=int
+
+       If using :option:`--output-format` of `normal`, set the significant figures 
+       to this value. Higher values will yield more precise IOPS and throughput 
+       units, while lower values will round. Requires a minimum value of 1 and a 
+       maximum value of 10. Defaults to 4.
+
 
 Error handling
 ~~~~~~~~~~~~~~