[libvirt] [PATCH] docs: Enhance memoryBacking/locked documentation

Mention the need to set memtune/hard_limit. https://bugzilla.redhat.com/show_bug.cgi?id=1035954 Signed-off-by: Jiri Denemark <jdenemar@redhat.com> --- docs/formatdomain.html.in | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 1850a2b..b4ee9f3 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -638,7 +638,10 @@ <dt><code>locked</code></dt> <dd>When set and supported by the hypervisor, memory pages belonging to the domain will be locked in host's memory and the host will not - be allowed to swap them out. + be allowed to swap them out. For QEMU/KVM this requires + <code>hard_limit</code> <a href="#elementsMemoryTuning">memory tunning</a> + element to be used and set to the maximum memory configured for the + domain plus any memory consumed by the QEMU process itself. <span class="since">Since 1.0.6</span></dd> </dl> -- 1.8.5.1

On Mon, Dec 09, 2013 at 03:43:55PM +0100, Jiri Denemark wrote:
Mention the need to set memtune/hard_limit.
https://bugzilla.redhat.com/show_bug.cgi?id=1035954 Signed-off-by: Jiri Denemark <jdenemar@redhat.com> --- docs/formatdomain.html.in | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 1850a2b..b4ee9f3 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -638,7 +638,10 @@ <dt><code>locked</code></dt> <dd>When set and supported by the hypervisor, memory pages belonging to the domain will be locked in host's memory and the host will not - be allowed to swap them out. + be allowed to swap them out. For QEMU/KVM this requires + <code>hard_limit</code> <a href="#elementsMemoryTuning">memory tunning</a> + element to be used and set to the maximum memory configured for the + domain plus any memory consumed by the QEMU process itself. <span class="since">Since 1.0.6</span></dd> </dl>
-- 1.8.5.1
ACK, Martin

On Mon, Dec 09, 2013 at 17:37:14 +0100, Martin Kletzander wrote:
On Mon, Dec 09, 2013 at 03:43:55PM +0100, Jiri Denemark wrote:
Mention the need to set memtune/hard_limit.
https://bugzilla.redhat.com/show_bug.cgi?id=1035954 Signed-off-by: Jiri Denemark <jdenemar@redhat.com> --- docs/formatdomain.html.in | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 1850a2b..b4ee9f3 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -638,7 +638,10 @@ <dt><code>locked</code></dt> <dd>When set and supported by the hypervisor, memory pages belonging to the domain will be locked in host's memory and the host will not - be allowed to swap them out. + be allowed to swap them out. For QEMU/KVM this requires + <code>hard_limit</code> <a href="#elementsMemoryTuning">memory tunning</a> + element to be used and set to the maximum memory configured for the + domain plus any memory consumed by the QEMU process itself. <span class="since">Since 1.0.6</span></dd> </dl>
-- 1.8.5.1
ACK,
Thanks, pushed. Jirka

On 12/09/2013 07:43 AM, Jiri Denemark wrote:
Mention the need to set memtune/hard_limit.
https://bugzilla.redhat.com/show_bug.cgi?id=1035954 Signed-off-by: Jiri Denemark <jdenemar@redhat.com> --- docs/formatdomain.html.in | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 1850a2b..b4ee9f3 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -638,7 +638,10 @@ <dt><code>locked</code></dt> <dd>When set and supported by the hypervisor, memory pages belonging to the domain will be locked in host's memory and the host will not - be allowed to swap them out. + be allowed to swap them out. For QEMU/KVM this requires + <code>hard_limit</code> <a href="#elementsMemoryTuning">memory tunning</a>
s/tunning/tuning/ I'll push the obvious fix as trivial. -- Eric Blake eblake redhat com +1-919-301-3266 Libvirt virtualization library http://libvirt.org
participants (3)
-
Eric Blake
-
Jiri Denemark
-
Martin Kletzander