improve documentation for nix.settings.sandbox (#188541)

* add information on the "relaxed" setting in `nix.settings.sandbox`
This commit is contained in:
Anand Suresh 2023-06-06 04:32:26 -04:00 committed by GitHub
parent 04c41a12cf
commit aa884b8f3d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -520,10 +520,17 @@ in
will set up automatically for each build. This prevents impurities
in builds by disallowing access to dependencies outside of the Nix
store by using network and mount namespaces in a chroot environment.
This is enabled by default even though it has a possible performance
impact due to the initial setup time of a sandbox for each build. It
doesn't affect derivation hashes, so changing this option will not
trigger a rebuild of packages.
When set to "relaxed", this option permits derivations that set
`__noChroot = true;` to run outside of the sandboxed environment.
Exercise caution when using this mode of operation! It is intended to
be a quick hack when building with packages that are not easily setup
to be built reproducibly.
'';
};