Document default nix-path value

This commit is contained in:
Naïm Favier 2023-01-27 15:25:07 +01:00
parent 1cba5984a6
commit dba9173a1d
No known key found for this signature in database
GPG key ID: 95AFCE8211908325

View file

@ -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",