docs: clarify opendir description

Make explicit how opendir deals with colons in the path. Fixes: axboe#1573 Signed-off-by: Vincent Fu <[email protected]>
kawasaki · Jun 16, 2023 · 8ce9c40 · 8ce9c40
1 parent 62ac664
commit 8ce9c40
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/HOWTO.rst b/HOWTO.rst
@@ -843,7 +843,9 @@ Target file/device
 
 .. option:: opendir=str
 
-	Recursively open any files below directory `str`.
+        Recursively open any files below directory `str`. This accepts only a
+        single directory and unlike related options, colons appearing in the
+        path must not be escaped.
 
 .. option:: lockfile=str
 

diff --git a/fio.1 b/fio.1
@@ -627,7 +627,9 @@ generated filenames (with a directory specified) with the source of the
 client connecting. To disable this behavior, set this option to 0.
 .TP
 .BI opendir \fR=\fPstr
-Recursively open any files below directory \fIstr\fR.
+Recursively open any files below directory \fIstr\fR. This accepts only a
+single directory and unlike related options, colons appearing in the path must
+not be escaped.
 .TP
 .BI lockfile \fR=\fPstr
 Fio defaults to not locking any files before it does I/O to them. If a file