d4bc58b38d
When I first read the `README.md` I didn't know what this `mg build` was. Some grepping around turned up `/tools/magrathea`. Apparently this thing "helps me build planets". Awesome! Let's tell other people where to find it. It seems that this tool is (currently) specific to depot, so people who arrive at depot because of tvix probably won't know where to find `mg`. Signed-off-by: Adam Joseph <adam@westernsemico.com> Change-Id: Icb8c51087fd41b696794516abcfee24a4b3b4a14 Reviewed-on: https://cl.tvl.fyi/c/depot/+/6948 Reviewed-by: tazjin <tazjin@tvl.su> Tested-by: tazjin <tazjin@tvl.su>
2.1 KiB
Tvix Evaluator
This project implements an interpreter for the Nix programming language. You can experiment with an online version of the evaluator: tvixbolt.
The interpreter aims to be compatible with nixpkgs, on the
foundation of Nix 2.3.
Important note: The evaluator is not yet feature-complete, and while the core mechanisms (compiler, runtime, ...) have stabilised somewhat, a lot of components are still changing rapidly.
Please contact TVL with any questions you might have.
Building the evaluator
If you are in a full checkout of the TVL depot, you can simply run mg build in this directory (or mg build //tvix/eval from anywhere in
the repo). The mg command is found in /tools/magrathea.
Important note: We only use and test Nix builds of our software against Nix 2.3. There are a variety of bugs and subtle problems in newer Nix versions which we do not have the bandwidth to address, builds in newer Nix versions may or may not work.
The evaluator can also be built with standard Rust tooling (i.e.
cargo build).
If you would like to clone only the evaluator and build it directly with Rust tooling, you can do:
git clone https://code.tvl.fyi/depot.git:/tvix/eval.git tvix-eval
cd tvix-eval && cargo build
Nix test suite
C++ Nix implements a language test suite in the form of Nix source code files, and their expected output. The coverage of this test suite is not complete, but we intend to be compatible with it.
We have ported the test suite to Tvix, but do not run it by default as we are not yet compatible with it.
You can run the test suite by enabling the nix_tests feature in
Cargo:
cargo test --features nix_tests
rnix-parser
Tvix is written in memory of jD91mZM2, the author of rnix-parser who sadly passed away.
Tvix makes heavy use of rnix-parser in its bytecode compiler. The parser is now maintained by Nix community members.