doc: minor formatting fixes
[fio.git] / HOWTO
diff --git a/HOWTO b/HOWTO
index 22a58496921ba229db6a413696595aaa014d5ca9..83583028ae70ffdd330e26f82e42860d17a72e0b 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -1128,13 +1128,20 @@ I/O type
 .. option:: offset=int
 
        Start I/O at the provided offset in the file, given as either a fixed size in
-       bytes or a percentage. If a percentage is given, the next ``blockalign``-ed
-       offset will be used. Data before the given offset will not be touched. This
+       bytes or a percentage. If a percentage is given, the generated offset will be
+       aligned to the minimum ``blocksize`` or to the value of ``offset_align`` if
+       provided. Data before the given offset will not be touched. This
        effectively caps the file size at `real_size - offset`. Can be combined with
        :option:`size` to constrain the start and end range of the I/O workload.
        A percentage can be specified by a number between 1 and 100 followed by '%',
        for example, ``offset=20%`` to specify 20%.
 
+.. option:: offset_align=int
+
+       If set to non-zero value, the byte offset generated by a percentage ``offset``
+       is aligned upwards to this value. Defaults to 0 meaning that a percentage
+       offset is aligned to the minimum block size.
+
 .. option:: offset_increment=int
 
        If this is provided, then the real offset becomes `offset + offset_increment
@@ -1808,9 +1815,9 @@ I/O engine
                        details of writing an external I/O engine.
 
                **filecreate**
-                       Simply create the files and do no IO to them.  You still need to
+                       Simply create the files and do no I/O to them.  You still need to
                        set  `filesize` so that all the accounting still occurs, but no
-                       actual IO will be done other than creating the file.
+                       actual I/O will be done other than creating the file.
 
 I/O engine specific parameters
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -2053,7 +2060,7 @@ I/O depth
        changing data and the overlapping region has a non-zero size. Setting
        ``serialize_overlap`` tells fio to avoid provoking this behavior by explicitly
        serializing in-flight I/Os that have a non-zero overlap. Note that setting
-       this option can reduce both performance and the `:option:iodepth` achieved.
+       this option can reduce both performance and the :option:`iodepth` achieved.
        Additionally this option does not work when :option:`io_submit_mode` is set to
        offload. Default: false.
 
@@ -2881,7 +2888,7 @@ Measurements and reporting
 
 .. option:: lat_percentiles=bool
 
-       Enable the reporting of percentiles of IO latencies. This is similar
+       Enable the reporting of percentiles of I/O latencies. This is similar
        to :option:`clat_percentiles`, except that this includes the
        submission latency. This option is mutually exclusive with
        :option:`clat_percentiles`.
@@ -3251,7 +3258,7 @@ writes in the example above).  In the order listed, they denote:
                short or dropped.
 
 **IO latency**
-               These values are for `--latency-target` and related options. When
+               These values are for :option:`latency_target` and related options. When
                these options are engaged, this section describes the I/O depth required
                to meet the specified latency target.