add documentation about filename_format directory behavior

We've changed the behavior of filename_format, document that fact.

Signed-off-by: Josef Bacik <jbacik@fb.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>

diff --git a/HOWTO b/HOWTO
index d3f957bf4db7ecdeab63bfc5f38bbbd8150881be..a1513e1259f7cc3001fb185a662150a9527dba34 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -795,6 +795,13 @@ Target file/device
        named :file:`testfiles.4`. The default of :file:`$jobname.$jobnum.$filenum`
        will be used if no other format specifier is given.
 
        named :file:`testfiles.4`. The default of :file:`$jobname.$jobnum.$filenum`
        will be used if no other format specifier is given.
 

+       If you specify a path then the directories will be created up to the
+       main directory for the file.  So for example if you specify
+       ``filename_format=a/b/c/$jobnum`` then the directories a/b/c will be
+       created before the file setup part of the job.  If you specify
+       :option:`directory` then the path will be relative that directory,
+       otherwise it is treated as the absolute path.
+

 .. option:: unique_filename=bool
 
        To avoid collisions between networked clients, fio defaults to prefixing any
 .. option:: unique_filename=bool
 
        To avoid collisions between networked clients, fio defaults to prefixing any

diff --git a/fio.1 b/fio.1
index 6e7d1f8b1e4647e3e87912304a67c5e51101222b..7787ef29c2b3028e6950f9d765ffc0b87fe4eda5 100644 (file)
--- a/fio.1
+++ b/fio.1
@@ -578,6 +578,12 @@ fio generate filenames that are shared between the two. For instance, if
 `testfiles.$filenum' is specified, file number 4 for any job will be
 named `testfiles.4'. The default of `$jobname.$jobnum.$filenum'
 will be used if no other format specifier is given.
 `testfiles.$filenum' is specified, file number 4 for any job will be
 named `testfiles.4'. The default of `$jobname.$jobnum.$filenum'
 will be used if no other format specifier is given.

+.P
+If you specify a path then the directories will be created up to the main
+directory for the file.  So for example if you specify `a/b/c/$jobnum` then the
+directories a/b/c will be created before the file setup part of the job.  If you
+specify \fBdirectory\fR then the path will be relative that directory, otherwise
+it is treated as the absolute path.

 .RE
 .TP
 .BI unique_filename \fR=\fPbool
 .RE
 .TP
 .BI unique_filename \fR=\fPbool