diff options
Diffstat (limited to 'tvix/README.md')
-rw-r--r-- | tvix/README.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/tvix/README.md b/tvix/README.md index bf96afa4ba3f..af12d6ff4b10 100644 --- a/tvix/README.md +++ b/tvix/README.md @@ -61,8 +61,7 @@ This folder contains the following components: * `//tvix/castore` - subtree storage/transfer in a content-addressed fashion * `//tvix/cli` - preliminary REPL & CLI implementation for Tvix * `//tvix/eval` - an implementation of the Nix programming language -* `//tvix/nar-bridge` - * `nar-bridge-http`: A HTTP webserver providing a Nix HTTP Binary Cache interface in front of a tvix-store +* `//tvix/nar-bridge` - a HTTP webserver providing a Nix HTTP Binary Cache interface in front of a tvix-store * `//tvix/nix-compat` - a Rust library for compatibility with C++ Nix, features like encodings and hashing schemes and formats * `//tvix/serde` - a Rust library for using the Nix language for app configuration * `//tvix/store` - a "filesystem" linking Nix store paths and metadata with the content-addressed layer @@ -105,6 +104,11 @@ Rust projects under `//tvix`, be sure to run `mg run //tools:crate2nix-generate` in `//tvix` itself and commit the changes to the generated `Cargo.nix` file. This only applies to the full TVL checkout. +When adding/removing a Cargo feature for a crate, you will want to add it to the +features power set that gets tested in CI. For each crate there's a default.nix with a +`mkFeaturePowerset` invocation, modify the list to include/remove the feature. +Note that you don't want to add "collection" features, such as `fs` for tvix-[ca]store or `default`. + ## License structure All code implemented for Tvix is licensed under the GPL-3.0, with the |