[bug#34161] doc: clarify build users must be in kvm group

Message ID 87k1ixrgqo.fsf@roquette.mug.biscuolo.net
State Accepted
Headers show
Series [bug#34161] doc: clarify build users must be in kvm group | expand

Checks

Context Check Description
cbaines/applying patch success Successfully applied

Commit Message

Giovanni Biscuolo Jan. 21, 2019, 6:46 p.m. UTC
Hi maitainers!

here is a small patch to (guix)Invoking guix system

rationale in
https://lists.gnu.org/archive/html/help-guix/2019-01/msg00272.html

Thanks!

Comments

Ludovic Courtès Jan. 25, 2019, 9:55 p.m. UTC | #1
Hi Giovanni,

Giovanni Biscuolo <g@xelera.eu> skribis:

>>From 577f3e5750ec23cadf19cea68fe21aa5d2e7b9fa Mon Sep 17 00:00:00 2001
> From: Giovanni Biscuolo <g@xelera.eu>
> Date: Mon, 21 Jan 2019 19:10:45 +0100
> Subject: [PATCH] doc: clarify build users must be in kvm group
> To: guix-patches@gnu.org
>
> * doc/guix.texi: (guix)Invoke guix system, clarify kvm users must be in
>   kvm group when using `guix system vm`

There’s already a note a few lines below that links to “Build
Environment Setup” for more details:

  https://www.gnu.org/software/guix/manual/en/html_node/Invoking-guix-system.html

However, the note is admittedly too far away from the description of
‘vm’ so I’ve moved it higher (will push shortly.)

Thanks,
Ludo’.

Patch

From 577f3e5750ec23cadf19cea68fe21aa5d2e7b9fa Mon Sep 17 00:00:00 2001
From: Giovanni Biscuolo <g@xelera.eu>
Date: Mon, 21 Jan 2019 19:10:45 +0100
Subject: [PATCH] doc: clarify build users must be in kvm group
To: guix-patches@gnu.org

* doc/guix.texi: (guix)Invoke guix system, clarify kvm users must be in
  kvm group when using `guix system vm`
---
 doc/guix.texi | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/doc/guix.texi b/doc/guix.texi
index 245a18bc7..a3a27628f 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -22942,6 +22942,19 @@  passed.
 @anchor{guix system vm}
 Build a virtual machine that contains the operating system declared in
 @var{file}, and return a script to run that virtual machine (VM).
+To use this command, you may need to add the build users to the @code{kvm}
+group so they can access @file{/dev/kvm} (@pxref{Build Environment Setup}).
+
+On a GNU/Linux system, a build user pool groups may be changed like this
+(using Bash syntax and the @code{shadow} commands):
+
+@example
+# for i in `seq -w 1 10`;
+  do
+    usermod -G guixbuild,kvm guixbuilder$i;
+  done
+@end example
+
 Arguments given to the script are passed to QEMU as in the example
 below, which enables networking and requests 1@tie{}GiB of RAM for the
 emulated machine:
-- 
q2.11.0