From 681c50c34fb55f06d4a41f12dc84c4c6e6f22bfb Mon Sep 17 00:00:00 2001
Message-Id: <681c50c34fb55f06d4a41f12dc84c4c6e6f22bfb.1377873642.git.jdenemar@redhat.com>
From: Michal Privoznik <mprivozn@redhat.com>
Date: Mon, 26 Aug 2013 17:41:46 +0200
Subject: [PATCH] docs: Discourage users to set hard_limit

https://bugzilla.redhat.com/show_bug.cgi?id=1001143

In one of my previous patches I am removing the hard_limit heuristic to
guess the correct value if none set. However, it turned out, this limit
is hard to guess even for users. We should advise them to not set the
limit as their domains may be OOM killed. Sigh.
(cherry picked from commit 09adfdc62de2bbba71580839f735ec07a356c762)
---
 docs/formatdomain.html.in | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index a1803df..fb4238e 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -676,7 +676,11 @@
       <dt><code>hard_limit</code></dt>
       <dd> The optional <code>hard_limit</code> element is the maximum memory
         the guest can use. The units for this value are kibibytes (i.e. blocks
-        of 1024 bytes)</dd>
+        of 1024 bytes). <strong>However, users of QEMU and KVM are strongly
+        advised not to set this limit as domain may get killed by the kernel.
+        To determine the memory needed for a process to run is
+        <a href="http://en.wikipedia.org/wiki/Undecidable_problem">
+        undecidable problem</a>.</strong></dd>
       <dt><code>soft_limit</code></dt>
       <dd> The optional <code>soft_limit</code> element is the memory limit to
         enforce during memory contention. The units for this value are
-- 
1.8.3.2