From c75fa365cdcfb2ca283da6e35dbe6ace229e2366 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Fri, 12 Aug 2022 14:25:07 +0300 Subject: docs(tvix/eval): add README note on running the Nix test suite Change-Id: I792154d5fea05414f2b14367ea4087dc2a88758e Reviewed-on: https://cl.tvl.fyi/c/depot/+/6130 Tested-by: BuildkiteCI Reviewed-by: grfn --- tvix/eval/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/tvix/eval/README.md b/tvix/eval/README.md index 8320aa8ea378..dc588e001db9 100644 --- a/tvix/eval/README.md +++ b/tvix/eval/README.md @@ -18,6 +18,18 @@ 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. +## 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. + ## rnix-parser Tvix is written in memory of jD91mZM2, the author of [rnix-parser][] -- cgit 1.4.1