[libvirt] [PATCH] formatdomain.html.in: Amend the 'random' RNG backend section

Kashyap Chamarthy posted 1 patch 5 years, 10 months ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20180622100939.24340-1-kchamart@redhat.com
Test syntax-check passed
docs/formatdomain.html.in | 16 ++++++++++------
1 file changed, 10 insertions(+), 6 deletions(-)
[libvirt] [PATCH] formatdomain.html.in: Amend the 'random' RNG backend section
Posted by Kashyap Chamarthy 5 years, 10 months ago
Since libvirt 1.3.4, any RNG source is accepted for the 'random'
backend.  However, '/dev/urandom' is the _recommended_ source of
entropy.

Mention it so in the docs.

Suggested-by: Daniel P. Berrangé <berrange@redhat.com>
Signed-off-by: Kashyap Chamarthy <kchamart@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>
-- 
2.17.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
Re: [libvirt] [PATCH] formatdomain.html.in: Amend the 'random' RNG backend section
Posted by Erik Skultety 5 years, 9 months ago
On Fri, Jun 22, 2018 at 12:09:39PM +0200, Kashyap Chamarthy wrote:
> Since libvirt 1.3.4, any RNG source is accepted for the 'random'
> backend.  However, '/dev/urandom' is the _recommended_ source of
> entropy.
>

s/\n//

> Mention it so in the docs.

"Therefore we should mention that in the docs."

With that
Reviewed-by: Erik Skultety <eskultet@redhat.com>

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
Re: [libvirt] [PATCH] formatdomain.html.in: Amend the 'random' RNG backend section
Posted by Kashyap Chamarthy 5 years, 9 months ago
On Mon, Jun 25, 2018 at 10:57:31AM +0200, Erik Skultety wrote:
> On Fri, Jun 22, 2018 at 12:09:39PM +0200, Kashyap Chamarthy wrote:
> > Since libvirt 1.3.4, any RNG source is accepted for the 'random'
> > backend.  However, '/dev/urandom' is the _recommended_ source of
> > entropy.
> >
> 
> s/\n//
> 
> > Mention it so in the docs.
> 
> "Therefore we should mention that in the docs."
> 
> With that
> Reviewed-by: Erik Skultety <eskultet@redhat.com>

Whoever is pushing the ptach can amend that I hope.

Thanks!

-- 
/kashyap

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
Re: [libvirt] [PATCH] formatdomain.html.in: Amend the 'random' RNG backend section
Posted by Erik Skultety 5 years, 9 months ago
On Mon, Jun 25, 2018 at 11:10:29AM +0200, Kashyap Chamarthy wrote:
> On Mon, Jun 25, 2018 at 10:57:31AM +0200, Erik Skultety wrote:
> > On Fri, Jun 22, 2018 at 12:09:39PM +0200, Kashyap Chamarthy wrote:
> > > Since libvirt 1.3.4, any RNG source is accepted for the 'random'
> > > backend.  However, '/dev/urandom' is the _recommended_ source of
> > > entropy.
> > >
> >
> > s/\n//
> >
> > > Mention it so in the docs.
> >
> > "Therefore we should mention that in the docs."
> >
> > With that
> > Reviewed-by: Erik Skultety <eskultet@redhat.com>
>
> Whoever is pushing the ptach can amend that I hope.
>
> Thanks!

Ah, I didn't realize you don't have commit permissions, I'll take care of that.

Erik

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list