doc: stop saying backslashes need escaping
authorSitsofe Wheeler <sitsofe@yahoo.com>
Wed, 30 Oct 2019 06:14:12 +0000 (06:14 +0000)
committerSitsofe Wheeler <sitsofe@yahoo.com>
Sat, 21 Dec 2019 11:51:58 +0000 (11:51 +0000)
In 02dd2689885c6d64d9d01a92e67d40f73c0afc72 ("HOWTO: update directory
and filename option descriptions") I added a change that stated that
backslashes needed escaping too but this is not (and never has been) the
case. Fix this thinko by removing all mentions of backslash escaping
being needed from the documentation.

Signed-off-by: Sitsofe Wheeler <sitsofe@yahoo.com>
HOWTO
fio.1

diff --git a/HOWTO b/HOWTO
index 41a667a..7895eba 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.
@@ -2564,7 +2564,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
diff --git a/fio.1 b/fio.1
index a60863f..cf5dd85 100644 (file)
--- a/fio.1
+++ b/fio.1
@@ -536,7 +536,7 @@ set fio will use the first listed directory, and thereby matching the
 specified, but lets all clones use the same file if set).
 .RS
 .P
-See the \fBfilename\fR option for information on how to escape ':' and '\\'
+See the \fBfilename\fR option for information on how to escape ':'
 characters within the directory path itself.
 .P
 Note: To control the directory fio will use for internal state files
@@ -557,10 +557,10 @@ by this option will be \fBsize\fR divided by number of files unless an
 explicit size is specified by \fBfilesize\fR.
 .RS
 .P
-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 `/dev/dsk/foo@3,0:c' then you
 would use `filename=/dev/dsk/foo@3,0\\:c' and if the path is
-`F:\\filename' then you would use `filename=F\\:\\\\filename'.
+`F:\\filename' then you would use `filename=F\\:\\filename'.
 .P
 On Windows, disk devices are accessed as `\\\\.\\PhysicalDrive0' for
 the first device, `\\\\.\\PhysicalDrive1' for the second etc.
@@ -2277,7 +2277,7 @@ to replay a workload captured by blktrace. See
 replay, the file needs to be turned into a blkparse binary data file first
 (`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 \fBfilename\fR option for information on how to escape ':' and '\'
+See the \fBfilename\fR option for information on how to escape ':'
 characters within the file names. These files will be sequentially assigned to
 job clones created by \fBnumjobs\fR.
 .TP