diff options
| author | Naïm Favier <n@monade.li> | 2023-01-27 15:25:07 +0100 |
|---|---|---|
| committer | Naïm Favier <n@monade.li> | 2023-01-27 15:25:07 +0100 |
| commit | dba9173a1d8cb1dd40e5922d009cb3a434e081c3 (patch) | |
| tree | 30aac6a8dae9eb3641d1f36a79ef45f0968c468d /src/libexpr/eval.hh | |
| parent | 1cba5984a68a489c4a56691032e4c87991c678f4 (diff) | |
Document default `nix-path` value
Diffstat (limited to 'src/libexpr/eval.hh')
| -rw-r--r-- | src/libexpr/eval.hh | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/src/libexpr/eval.hh b/src/libexpr/eval.hh index 876a6ae0e..2340ef67b 100644 --- a/src/libexpr/eval.hh +++ b/src/libexpr/eval.hh @@ -581,7 +581,14 @@ struct EvalSettings : Config Setting<Strings> nixPath{ this, {}, "nix-path", - "List of directories to be searched for `<...>` file references."}; + R"( + List of directories to be searched for `<...>` file references. + + If [pure evaluation](#conf-pure-eval) is disabled, + this is initialised using the [`NIX_PATH`](@docroot@/command-ref/env-common.md#env-NIX_PATH) + environment variable, or, if it is unset and [restricted evaluation](#conf-restrict-eval) + is disabled, a default search path including the user's and `root`'s channels. + )"}; Setting<bool> restrictEval{ this, false, "restrict-eval", |