Skip to content

Commit

Permalink
docs: add warning to per_job_logs option
Browse files Browse the repository at this point in the history
Add a warning about the file open mode used when per_job_logs is set to
false. Log files are opened in append mode, so if the files already
exist, the previous contents will not be overwritten.

Signed-off-by: Vincent Fu <vincent.fu@samsung.com>
  • Loading branch information
vincentkfu committed Nov 6, 2023
1 parent 9af6c38 commit 05fce19
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
8 changes: 5 additions & 3 deletions HOWTO.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3968,9 +3968,11 @@ Measurements and reporting

.. option:: per_job_logs=bool

If set, this generates bw/clat/iops log with per file private filenames. If
not set, jobs with identical names will share the log filename. Default:
true.
If set to true, fio generates bw/clat/iops logs with per job unique
filenames. If set to false, jobs with identical names will share a log
filename. Note that when this option is set to false log files will be
opened in append mode and if log files already exist the previous
contents will not be overwritten. Default: true.

.. option:: group_reporting

Expand Down
6 changes: 4 additions & 2 deletions fio.1
Original file line number Diff line number Diff line change
Expand Up @@ -3667,8 +3667,10 @@ interpreted in seconds.
.SS "Measurements and reporting"
.TP
.BI per_job_logs \fR=\fPbool
If set, this generates bw/clat/iops log with per file private filenames. If
not set, jobs with identical names will share the log filename. Default:
If set to true, fio generates bw/clat/iops logs with per job unique filenames.
If set to false, jobs with identical names will share a log filename. Note that
when this option is set to false log files will be opened in append mode and if
log files already exist the previous contents will not be overwritten. Default:
true.
.TP
.BI group_reporting
Expand Down

0 comments on commit 05fce19

Please sign in to comment.