mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(tvix/eval): add some notes on cloning & building tvix-eval

Browse source 
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
This commit is contained in:
Vincent Ambo 2022-09-11 15:33:15 +03:00 committed by clbot
parent 19c0723045
commit 3f1df1916f
1 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
tvix/eval/README.md
View file

@ -18,6 +18,29 @@ We expect this to have caught up in a handful of weeks (as of
Please contact [TVL](https://tvl.fyi) 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:
```bash
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