Merge branch 'doc_fixes' of https://github.com/sitsofe/fio

[fio.git] / HOWTO

diff --git a/HOWTO b/HOWTO
index 41a667af4406a17b215952faa7ef3511bc0bb801..41d32c04dc638b12de1dc20e9444ed4462c81051 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -765,8 +765,8 @@ Target file/device
        `filename` semantic (which generates a file for each clone if not
        specified, but lets all clones use the same file if set).
 
-       See the :option:`filename` option for information on how to escape "``:``" and
-       "``\``" characters within the directory path itself.
+       See the :option:`filename` option for information on how to escape "``:``"
+       characters within the directory path itself.
 
        Note: To control the directory fio will use for internal state files
        use :option:`--aux-path`.
@@ -785,10 +785,10 @@ Target file/device
        by this option will be :option:`size` divided by number of files unless an
        explicit size is specified by :option:`filesize`.
 
-       Each colon and backslash in the wanted path must be escaped with a ``\``
+       Each colon in the wanted path must be escaped with a ``\``
        character.  For instance, if the path is :file:`/dev/dsk/foo@3,0:c` then you
        would use ``filename=/dev/dsk/foo@3,0\:c`` and if the path is
-       :file:`F:\\filename` then you would use ``filename=F\:\\filename``.
+       :file:`F:\\filename` then you would use ``filename=F\:\filename``.
 
        On Windows, disk devices are accessed as :file:`\\\\.\\PhysicalDrive0` for
        the first device, :file:`\\\\.\\PhysicalDrive1` for the second etc.
@@ -2046,6 +2046,7 @@ with the caveat that when used on the command line, they must come after the
        IO latency as well.
 
 .. option:: registerfiles : [io_uring]
+
        With this option, fio registers the set of files being used with the
        kernel. This avoids the overhead of managing file counts in the kernel,
        making the submission and completion part more lightweight. Required
@@ -2564,7 +2565,7 @@ I/O replay
        (``blkparse <device> -o /dev/null -d file_for_fio.bin``).
        You can specify a number of files by separating the names with a ':'
        character. See the :option:`filename` option for information on how to
-       escape ':' and '\' characters within the file names. These files will
+       escape ':' characters within the file names. These files will
        be sequentially assigned to job clones created by :option:`numjobs`.
 
 .. option:: read_iolog_chunked=bool
@@ -3990,7 +3991,7 @@ only file passed to :option:`read_iolog`. An example would look like::
        $ fio --read_iolog="<file1>:<file2>" --merge_blktrace_file="<output_file>"
 
 Creating only the merged file can be done by passing the command line argument
-:option:`merge-blktrace-only`.
+:option:`--merge-blktrace-only`.
 
 Scaling traces can be done to see the relative impact of any particular trace
 being slowed down or sped up. :option:`merge_blktrace_scalars` takes in a colon