Skip to content

Commit

Permalink
HOWTO/manpage: update percentage explanation using '%'
Browse files Browse the repository at this point in the history
82dbb8c (HOWTO: add offset unit info for offset= option) added
how to specify offset= option in percentage format based on below post,
which was technically correct, but str_to_decimal() invoked via
option parser can convert '%' format to low-level representation.

This commit replaces 82dbb8c using '%' syntax since this is
considered better for documentation. Note that size= option which
also supports percentage uses '%' in documentation.

in what units is offset option?
http://www.spinics.net/lists/fio/msg05969.html

Signed-off-by: Tomohiro Kusumi <[email protected]>
Signed-off-by: Jens Axboe <[email protected]>
  • Loading branch information
kusumi authored and axboe committed Jun 28, 2017
1 parent 867f90e commit 44bb114
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions HOWTO
Original file line number Diff line number Diff line change
Expand Up @@ -1095,8 +1095,8 @@ I/O type
offset will be used. Data before the given offset will not be touched. This
effectively caps the file size at `real_size - offset`. Can be combined with
:option:`size` to constrain the start and end range of the I/O workload.
A percentage can be specified by the percentage number plus 1 with preceding '-'.
For example, -1 is parsed as 0%, -10 is parsed as 9%, -101 is parsed as 100%.
A percentage can be specified by a number between 1 and 100 followed by '%',
for example, ``offset=20%`` to specify 20%.

.. option:: offset_increment=int

Expand Down
6 changes: 3 additions & 3 deletions fio.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH fio 1 "May 2017" "User Manual"
.TH fio 1 "June 2017" "User Manual"
.SH NAME
fio \- flexible I/O tester
.SH SYNOPSIS
Expand Down Expand Up @@ -916,8 +916,8 @@ bytes or a percentage. If a percentage is given, the next \fBblockalign\fR-ed
offset will be used. Data before the given offset will not be touched. This
effectively caps the file size at (real_size - offset). Can be combined with
\fBsize\fR to constrain the start and end range of the I/O workload. A percentage
can be specified by the percentage number plus 1 with preceding '-'. For example,
-1 is parsed as 0%, -10 is parsed as 9%, -101 is parsed as 100%.
can be specified by a number between 1 and 100 followed by '%', for example,
offset=20% to specify 20%.
.TP
.BI offset_increment \fR=\fPint
If this is provided, then the real offset becomes the
Expand Down

0 comments on commit 44bb114

Please sign in to comment.