about summary refs log tree commit diff
path: root/nix/readTree/README.md
diff options
context:
space:
mode:
authorVincent Ambo <mail@tazj.in>2021-09-08T15·27+0300
committertazjin <mail@tazj.in>2021-09-09T11·37+0000
commitb1f4b530ec1548d75c0e318fcdf90d33a373a5ca (patch)
treed28d07ceeb1e5d834764bfdd6dc66b0f7b25daa1 /nix/readTree/README.md
parentaedde913d125737f81e63edbc7481e886b0a4f2d (diff)
feat(readTree): Support scoped import arguments r/2825
This makes it possible to override Nix builtins within a readTree
structure. Why would you want to do that, you might ask? Well ...

Change-Id: Icc9cb32e5db4a2eba370cf81769c642d237d4937
Reviewed-on: https://cl.tvl.fyi/c/depot/+/3499
Tested-by: BuildkiteCI
Reviewed-by: sterni <sternenseemann@systemli.org>
Diffstat (limited to 'nix/readTree/README.md')
-rw-r--r--nix/readTree/README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/nix/readTree/README.md b/nix/readTree/README.md
index b56bc944caba..f8bbe2255e5e 100644
--- a/nix/readTree/README.md
+++ b/nix/readTree/README.md
@@ -77,6 +77,9 @@ the tree as empty nodes (`{}`).
 * `filter`: (optional) A function to filter the argument set on each
   import based on the location in the tree. This can be used to, for
   example, implement a "visibility" system inside of a tree.
+* `scopedArgs`: (optional) An argument set that is passed to all
+  imported files via `builtins.scopedImport`. This will forcefully
+  override the given values in the import scope, use with care!
 
 The package headers in this repository follow the form `{ pkgs, ... }:` where
 `pkgs` is a fixed-point of the entire package tree (see the `default.nix` at the