Provide some consistency in rate_* options
authorJens Axboe <axboe@fb.com>
Mon, 9 Nov 2015 23:05:19 +0000 (16:05 -0700)
committerJens Axboe <axboe@fb.com>
Mon, 9 Nov 2015 23:05:19 +0000 (16:05 -0700)
ratemin and ratecycle are the only ones without an underscore.
Change them to rate_min and rate_cycle, but retain the old
names as an alias for compat reasons.

Signed-off-by: Jens Axboe <axboe@fb.com>
HOWTO
fio.1
options.c

diff --git a/HOWTO b/HOWTO
index f8b488faac91285682cb9a9027b9ddaa7ecc804a..2742fd7994ec9e148975b1ee62a827b4a4d31a5f 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -1049,7 +1049,7 @@ rate=int  Cap the bandwidth used by this job. The number is in bytes/sec,
                will only limit writes (to 500KB/sec), the latter will only
                limit reads.
 
-ratemin=int    Tell fio to do whatever it can to maintain at least this
+rate_min=int   Tell fio to do whatever it can to maintain at least this
                bandwidth. Failing to meet this requirement, will cause
                the job to exit. The same format as rate is used for
                read vs write separation.
@@ -1087,7 +1087,7 @@ latency_percentile=float  The percentage of IOs that must fall within the
 max_latency=int        If set, fio will exit the job if it exceeds this maximum
                latency. It will exit with an ETIME error.
 
-ratecycle=int  Average bandwidth for 'rate' and 'ratemin' over this number
+rate_cycle=int Average bandwidth for 'rate' and 'rate_min' over this number
                of milliseconds.
 
 cpumask=int    Set the CPU affinity of this job. The parameter given is a
diff --git a/fio.1 b/fio.1
index b8e31db691842695567d7e058733d6051c91384f..1b4c866947c05234c9126b3a8833acac7956015f 100644 (file)
--- a/fio.1
+++ b/fio.1
@@ -948,7 +948,7 @@ limit reads to 1MB/sec and writes to 500KB/sec. Capping only reads or writes
 can be done with \fBrate\fR=,500k or \fBrate\fR=500k,. The former will only
 limit writes (to 500KB/sec), the latter will only limit reads.
 .TP
-.BI ratemin \fR=\fPint
+.BI rate_min \fR=\fPint
 Tell \fBfio\fR to do whatever it can to maintain at least the given bandwidth.
 Failing to meet this requirement will cause the job to exit. The same format
 as \fBrate\fR is used for read vs write separation.
@@ -969,8 +969,8 @@ Real world random request flow follows Poisson process
 tries to simulate request flow under Poisson process (instead of even
 distribution, which is the default). Default: false.
 .TP
-.BI ratecycle \fR=\fPint
-Average bandwidth for \fBrate\fR and \fBratemin\fR over this number of
+.BI rate_cycle \fR=\fPint
+Average bandwidth for \fBrate\fR and \fBrate_min\fR over this number of
 milliseconds.  Default: 1000ms.
 .TP
 .BI latency_target \fR=\fPint
index ac41565c8677783aaa222ccf15929a74c1b7b39a..7f663bb8ffbe880c2e67bc0c8c021e1f8a52e784 100644 (file)
--- a/options.c
+++ b/options.c
@@ -2818,7 +2818,8 @@ struct fio_option fio_options[FIO_MAX_OPTS] = {
                .group  = FIO_OPT_G_RATE,
        },
        {
-               .name   = "ratemin",
+               .name   = "rate_min",
+               .alias  = "ratemin",
                .lname  = "I/O min rate",
                .type   = FIO_OPT_INT,
                .off1   = td_var_offset(ratemin[DDIR_READ]),
@@ -2868,7 +2869,8 @@ struct fio_option fio_options[FIO_MAX_OPTS] = {
                .group  = FIO_OPT_G_RATE,
        },
        {
-               .name   = "ratecycle",
+               .name   = "rate_cycle",
+               .alias  = "ratecycle",
                .lname  = "I/O rate cycle",
                .type   = FIO_OPT_INT,
                .off1   = td_var_offset(ratecycle),