From f4401bf88eccd7e188ee47eee25490afe824ed55 Mon Sep 17 00:00:00 2001 From: Sitsofe Wheeler Date: Sun, 12 Aug 2018 20:38:18 +0100 Subject: [PATCH] doc: rewording and add reference to --aux-path - Reword --aux-path definition - Reword "filename semantic" text in directory definition - Add reference to --aux-path from --filename definition Closes: https://github.com/axboe/fio/issues/530 Signed-off-by: Sitsofe Wheeler --- HOWTO | 10 +++++++--- fio.1 | 10 +++++++--- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/HOWTO b/HOWTO index 844c46e5..4c117c24 100644 --- a/HOWTO +++ b/HOWTO @@ -283,7 +283,8 @@ Command line options .. option:: --aux-path=path - Use this `path` for fio state generated files. + Use the directory specified by `path` for generated state files instead + of the current working directory. Any parameters following the options will be assumed to be job files, unless they match a job file parameter. Multiple job files can be listed and each job @@ -748,12 +749,15 @@ Target file/device assigned equally distributed to job clones created by :option:`numjobs` as long as they are using generated filenames. If specific `filename(s)` are set fio will use the first listed directory, and thereby matching the - `filename` semantic which generates a file each clone if not specified, but - let all clones use the same if set. + `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. + Note: To control the directory fio will use for internal state files + use :option:`--aux-path`. + .. option:: filename=str Fio normally makes up a `filename` based on the job name, thread number, and diff --git a/fio.1 b/fio.1 index a16f6e62..e465771c 100644 --- a/fio.1 +++ b/fio.1 @@ -168,7 +168,8 @@ Set this \fIcommand\fR as local trigger. Set this \fIcommand\fR as remote trigger. .TP .BI \-\-aux\-path \fR=\fPpath -Use this \fIpath\fR for fio state generated files. +Use the directory specified by \fIpath\fP for generated state files instead +of the current working directory. .SH "JOB FILE FORMAT" Any parameters following the options will be assumed to be job files, unless they match a job file parameter. Multiple job files can be listed and each job @@ -523,12 +524,15 @@ separating the names with a ':' character. These directories will be assigned equally distributed to job clones created by \fBnumjobs\fR as long as they are using generated filenames. If specific \fBfilename\fR(s) are set fio will use the first listed directory, and thereby matching the -\fBfilename\fR semantic which generates a file each clone if not specified, but -let all clones use the same if set. +\fBfilename\fR semantic (which generates a file for each clone if not +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 '\' characters within the directory path itself. +.P +Note: To control the directory fio will use for internal state files +use \fB\-\-aux\-path\fR. .RE .TP .BI filename \fR=\fPstr -- 2.25.1