diff options
author | David Vrabel <david.vrabel@citrix.com> | 2012-04-03 14:40:08 +0100 |
---|---|---|
committer | David Vrabel <david.vrabel@citrix.com> | 2012-04-03 14:40:08 +0100 |
commit | 6f3536e90c670fb82f8633afd76b52d9b9f5d90f (patch) | |
tree | 2cac120085868f47fd518e23d28b90c504d48539 | |
parent | 474a0e59d821bfb49b64c3d722a000bd9b5b7599 (diff) | |
download | xen-6f3536e90c670fb82f8633afd76b52d9b9f5d90f.tar.gz xen-6f3536e90c670fb82f8633afd76b52d9b9f5d90f.tar.bz2 xen-6f3536e90c670fb82f8633afd76b52d9b9f5d90f.zip |
docs: clarify documentation for the the dom0_mem command line option
This addresses Ian C's comments on v1 of a previous patch (which
was applied instead of v2).
Signed-off-by: David Vrabel <david.vrabel@citrix.com>
Committed-by: Ian Jackson <ian.jackson@eu.citrix.com>
-rw-r--r-- | docs/misc/xen-command-line.markdown | 22 |
1 files changed, 15 insertions, 7 deletions
diff --git a/docs/misc/xen-command-line.markdown b/docs/misc/xen-command-line.markdown index 4dc54286b8..a6195f207e 100644 --- a/docs/misc/xen-command-line.markdown +++ b/docs/misc/xen-command-line.markdown @@ -286,19 +286,27 @@ Specify the total size for dom0. > `= List of ( min:<size> | max:<size> | <size> )` Set the amount of memory for the initial domain (dom0). If a size is -positive, it represents an absolute value. If a size is negative, the -size specified is subtracted from the total available memory. +positive, it represents an absolute value. If a size is negative, it +is subtracted from the total available memory. -* `min:<size>` specifies the minimum amount of memory allocated to dom0. -* `max:<size>` specifies the maximum amount of memory allocated to dom0. -* `<size>` specified the exact amount of memory allocated to dom0. +* `<size>` specifies the exact amount of memory. +* `min:<size>` specifies the minimum amount of memory. +* `max:<size>` specifies the maximum amount of memory. + +If `<size>` is not specified, the default is all the available memory +minus some reserve. The reserve is 1/16 of the available memory or +128 MB (whichever is smaller). + +The amount of memory will be at least the minimum but never more than +the maximum (i.e., `max` overrides the `min` option). If there isn't +enough memory then as much as possible is allocated. `max:<size>` also sets the maximum reservation (the maximum amount of memory dom0 can balloon up to). If this is omitted then the maximum reservation is unlimited. -For example, to set dom0's memory to 512 MB but no more than 1 GB use -`dom0_mem=512M,max:1G`. +For example, to set dom0's initial memory allocation to 512MB but +allow it to balloon up as far as 1GB use `dom0_mem=512M,max:1G` ### dom0\_shadow ### dom0\_vcpus\_pin |