From 8ce9c4003aeaafa91c3278c1c7de4a32fadc5ea0 Mon Sep 17 00:00:00 2001 From: Vincent Fu Date: Fri, 16 Jun 2023 10:41:25 -0400 Subject: [PATCH] docs: clarify opendir description Make explicit how opendir deals with colons in the path. Fixes: https://github.com/axboe/fio/issues/1573 Signed-off-by: Vincent Fu --- HOWTO.rst | 4 +++- fio.1 | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/HOWTO.rst b/HOWTO.rst index 32fff5ecbd..2e1e55c26e 100644 --- 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 index 80bf3371a3..73b7e8c9ea 100644 --- 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