aboutsummaryrefslogtreecommitdiff
path: root/src/libstore/globals.hh
diff options
context:
space:
mode:
authorValentin Gagarin <valentin.gagarin@tweag.io>2022-12-01 04:40:02 +0100
committerValentin Gagarin <valentin.gagarin@tweag.io>2022-12-01 04:40:02 +0100
commit0ea62670eda39ebeaff5335fd8225707ec27e7a3 (patch)
tree47bbe846f28b4806ea4a8621a761ed3634bb960a /src/libstore/globals.hh
parent16b03f03af2cbd2b8a682d737371c3194096d5e6 (diff)
move documentation on `auto-allocate-uids` to options docs
this is where it belongs and can be found together with the other options.
Diffstat (limited to 'src/libstore/globals.hh')
-rw-r--r--src/libstore/globals.hh36
1 files changed, 30 insertions, 6 deletions
diff --git a/src/libstore/globals.hh b/src/libstore/globals.hh
index b40dcfa77..b61a34461 100644
--- a/src/libstore/globals.hh
+++ b/src/libstore/globals.hh
@@ -284,7 +284,21 @@ public:
)"};
Setting<bool> autoAllocateUids{this, false, "auto-allocate-uids",
- "Whether to allocate UIDs for builders automatically."};
+ R"(
+ Whether to allocate UIDs for builders automatically.
+
+ These UIDs are allocated starting at 872415232 (0x34000000) on Linux and 56930 on macOS.
+
+ > **Warning**
+ > This is an experimental feature.
+
+ To enable it, add the following to [`nix.conf`](#):
+
+ ```
+ extra-experimental-features = auto-allocate-uids
+ auto-allocate-uids = true
+ ```
+ )"};
Setting<uint32_t> startId{this,
#if __linux__
@@ -308,11 +322,21 @@ public:
Setting<bool> useCgroups{
this, false, "use-cgroups",
R"(
- Whether to execute builds inside cgroups. Cgroups are
- enabled automatically for derivations that require the
- `uid-range` system feature.
- )"
- };
+ Whether to execute builds inside cgroups.
+ Only on Linux with systemd.
+
+ cgroups are required and enabled automatically for derivations that require the `uid-range` system feature.
+
+ > **Warning**
+ > This is an experimental feature.
+
+ To enable it, add the following to [`nix.conf`](#):
+
+ ```
+ extra-experimental-features = cgroups
+ use-cgroups = true
+ ```
+ )"};
#endif
Setting<bool> impersonateLinux26{this, false, "impersonate-linux-26",