Document default nix-path value

NixOS · Jan 27, 2023 · dba9173 · dba9173
1 parent 1cba598
commit dba9173
Showing 1 changed file with 8 additions and 1 deletion.
diff --git 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",