History

Vincent Ambo 3f1df1916f docs(tvix/eval): add some notes on cloning & building tvix-eval Change-Id: I8cc359952b41994c2ba8bcfb8b0b6fc629bb81ea Reviewed-on: https://cl.tvl.fyi/c/depot/+/6502 Reviewed-by: sterni <sternenseemann@systemli.org> Autosubmit: tazjin <tazjin@tvl.su> Tested-by: BuildkiteCI		2022-09-11 19:58:44 +00:00
..
benches	test(tvix/eval): Add attr merge benchmarks	2022-09-03 06:56:02 +00:00
docs	docs(tvix/eval): add some notes on recursive attribute sets	2022-09-11 12:26:23 +00:00
src	fix(tvix/eval): pass correct slot when compiling attr values	2022-09-11 12:26:23 +00:00
.gitignore	feat(tvix/eval): check in generated project skeleton	2022-08-12 12:34:29 +00:00
.skip-subtree	feat(tvix/tests): check in Nix' language test suite	2022-08-24 21:25:41 +00:00
Cargo.lock	chore(tvix/eval): bump all dependencies	2022-09-07 19:08:56 +00:00
Cargo.toml	feat(tvix/eval): implement DisassemblingObserver for compiler	2022-09-09 21:10:10 +00:00
default.nix	fix(tvix/eval): don't rebuild drv upon changes in cargo target dir	2022-09-04 21:02:50 +00:00
README.md	docs(tvix/eval): add some notes on cloning & building tvix-eval	2022-09-11 19:58:44 +00:00

README.md

Tvix Evaluator

This project implements an interpreter for the Nix programming language.

The interpreter aims to be compatible with nixpkgs, on the foundation of Nix 2.3.

Work on this project is extremely in-progress, and the state of the project in the public repository may not necessarily reflect the state of the private codebase, as we are slowly working on publishing it.

We expect this to have caught up in a handful of weeks (as of 2022-08-12).

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).

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.