doc: add credit2_cap_period_ms boot parameter description
authorJuergen Gross <jgross@suse.com>
Mon, 7 May 2018 10:16:05 +0000 (12:16 +0200)
committerAndrew Cooper <andrew.cooper3@citrix.com>
Mon, 7 May 2018 10:52:58 +0000 (11:52 +0100)
credit2_cap_period_ms isn't mentioned in xen-command-line.markdown.
Add a description.

Signed-off-by: Juergen Gross <jgross@suse.com>
Acked-by: Andrew Cooper <andrew.cooper3@citrix.com>
docs/misc/xen-command-line.markdown

index b8afa719ac7d936936d3421908feeec0004eb88f..5b6571adf21771000126d0d8e91a358f5e5771c6 100644 (file)
@@ -568,6 +568,16 @@ which would otherwise require escaping of the < option
 ### credit2\_balance\_under
 > `= <integer>`
 
+### credit2\_cap\_period\_ms
+> `= <integer>`
+
+> Default: `10`
+
+Domains subject to a cap receive a replenishment of their runtime budget
+once every cap period interval. Default is 10 ms. The amount of budget
+they receive depends on their cap. For instance, a domain with a 50% cap
+will receive 50% of 10 ms, so 5 ms.
+
 ### credit2\_load\_precision\_shift
 > `= <integer>`