From d86b10cd49426e13e033b75f2cca6a4777c345cd Mon Sep 17 00:00:00 2001
From: Florian Sesser <florian@leastauthority.com>
Date: Thu, 14 Jan 2021 03:20:52 +0000
Subject: [PATCH] Readme: Mention why we suggest using sudo

---
 README.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/README.rst b/README.rst
index 94923c72..c7dcdd55 100644
--- a/README.rst
+++ b/README.rst
@@ -36,6 +36,9 @@ The system tests are run using this command::
   $ sudo --preserve-env nix-build nixos/system-tests.nix
 
 The system tests boot QEMU VMs which prevents them from running on CI at this time.
+Starting VMs require elevated privileges,
+which is the reason for the suggested ``sudo`` command,
+together with the ``--preserve-env`` option to avoid escaping the ``nix-shell`` set up at the top.
 The build requires > 10 GB of disk space, and the VMs might be timing out on slow or busy machines.
 If you run into timeouts, try `raising the number of retries <https://github.com/PrivateStorageio/PrivateStorageio/blob/e8233d2/nixos/modules/tests/run-introducer.py#L55-L62>`_.
 
-- 
GitLab