diff options
Diffstat (limited to 'nix/readTree/README.md')
| -rw-r--r-- | nix/readTree/README.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/nix/readTree/README.md b/nix/readTree/README.md index 138abbe30583..b56bc944caba 100644 --- a/nix/readTree/README.md +++ b/nix/readTree/README.md @@ -70,8 +70,13 @@ the tree as empty nodes (`{}`). ## Import structure -`readTree` is called with two parameters: The arguments to pass to all imports, -and the initial path at which to start the traversal. +`readTree` is called with an argument set containing a few parameters: + +* `path`: Initial path at which to start the traversal. +* `args`: Arguments to pass to all imports. +* `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. 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 |