From: Sitsofe Wheeler <sitsofe@yahoo.com>
Date: Fri, 23 Jun 2017 22:27:23 +0000 (+0100)
Subject: HOWTO: add rate example
X-Git-Tag: fio-2.99~37
X-Git-Url: https://git.kernel.dk/?p=fio.git;a=commitdiff_plain;h=b25b34645e4fec1ffb3fbb7674c95c064d0f657a;ds=sidebyside

HOWTO: add rate example

Signed-off-by: Sitsofe Wheeler <sitsofe@yahoo.com>
---

diff --git a/HOWTO b/HOWTO
index 4be23f05..742e0d26 100644
--- a/HOWTO
+++ b/HOWTO
@@ -2039,6 +2039,11 @@ I/O rate
 	suffix rules apply.  Comma-separated values may be specified for reads,
 	writes, and trims as described in :option:`blocksize`.
 
+	For example, using `rate=1m,500k` would limit reads to 1MiB/sec and writes to
+	500KiB/sec.  Capping only reads or writes can be done with `rate=,500k` or
+	`rate=500k,` where the former will only limit writes (to 500KiB/sec) and the
+	latter will only limit reads.
+
 .. option:: rate_min=int[,int][,int]
 
 	Tell fio to do whatever it can to maintain at least this bandwidth. Failing