aboutsummaryrefslogtreecommitdiff
path: root/docs/throttle.txt
diff options
context:
space:
mode:
authorAlberto Garcia <berto@igalia.com>2016-06-08 13:54:48 +0300
committerMichael Tokarev <mjt@gandalf>2016-09-13 18:12:34 +0300
commit37e3645ad3974db6008c212edf68c7f9da1bedc7 (patch)
tree225f5d4513e5dffcca8f4afa3ceaf47c5074a1d6 /docs/throttle.txt
parentfa9701240951093907076db0943f96972a396ef5 (diff)
docs: Fix description of the leaky bucket algorithm in throttle.txt
Commit 0bab0ebb17759c926bd48fd396bd8cbb2c8e4a3e was supposed to fix a mistake in the description of the leaky bucket algorithm, but the version that finally landed after the review process was incorrect. This patch solves that problem and hopefully clarifies the description a bit better. Signed-off-by: Alberto Garcia <berto@igalia.com> Signed-off-by: Michael Tokarev <mjt@tls.msk.ru>
Diffstat (limited to 'docs/throttle.txt')
-rw-r--r--docs/throttle.txt5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/throttle.txt b/docs/throttle.txt
index 26d4d5107f..cd4e109d39 100644
--- a/docs/throttle.txt
+++ b/docs/throttle.txt
@@ -235,7 +235,10 @@ consider the following values:
- Water leaks from the bucket at a rate of 100 IOPS.
- Water can be added to the bucket at a rate of 2000 IOPS.
- The size of the bucket is 2000 x 60 = 120000
- - If 'iops-total-max' is unset then the bucket size is 100 x 60.
+ - If 'iops-total-max-length' is unset then it defaults to 1 and the
+ size of the bucket is 2000.
+ - If 'iops-total-max' is unset then 'iops-total-max-length' must be
+ unset as well. In this case the bucket size is 100.
The bucket is initially empty, therefore water can be added until it's
full at a rate of 2000 IOPS (the burst rate). Once the bucket is full