From a2913aed53ae6c396a7fc16628d2c37d8c02f324 Mon Sep 17 00:00:00 2001
From: Kashyap Chamarthy <kchamart@redhat.com>
Date: Fri, 22 Jun 2018 12:09:39 +0200
Subject: [PATCH] docs: formatdomain: Mention that 'urandom' is the recommended
 RNG backend
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Since libvirt 1.3.4, any RNG source is accepted for the 'random'
backend.  However, '/dev/urandom' is the _recommended_ source of
entropy. Therefore we should mention that in the docs.

Suggested-by: Daniel P. Berrangé <berrange@redhat.com>
Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
Reviewed-by: Erik Skultety <eskultet@redhat.com>
---
 docs/formatdomain.html.in | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 89672a0486..3dd6a59a01 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -7738,12 +7738,16 @@ qemu-kvm -net nic,model=? /dev/null
           <dt><code>random</code></dt>
           <dd>
             <p>
-              This backend type expects a non-blocking character device as
-              input. The file name is specified as contents of the
-              <code>backend</code> element. <span class='since'>Since 1.3.4</span>
-              any path is accepted. Before that /dev/random and /dev/hwrng were
-              the only accepted paths. When no file name is specified the hypervisor
-              default is used. For qemu, the default is /dev/random
+              This backend type expects a non-blocking character device
+              as input. The file name is specified as contents of the
+              <code>backend</code> element. <span class='since'>Since
+              1.3.4</span> any path is accepted. Before that
+              <code>/dev/random</code> and <code>/dev/hwrng</code> were
+              the only accepted paths. When no file name is specified,
+              the hypervisor default is used. For QEMU, the default is
+              <code>/dev/random</code>. However, the recommended source
+              of entropy is <code>/dev/urandom</code> (as it doesn't
+              have the limitations of <code>/dev/random</code>).
             </p>
           </dd>
           <dt><code>egd</code></dt>
-- 
GitLab