diff options
| author | Vincent Ambo <mail@tazj.in> | 2022-12-07T11·05+0300 |
|---|---|---|
| committer | tazjin <tazjin@tvl.su> | 2022-12-15T17·26+0000 |
| commit | 3aca3d3bba54eaedefc7c472af8bca16ce1f163d (patch) | |
| tree | ab80d07c6c787e59ffbe90bb36d97bc35ae26b96 /tvix/README.md | |
| parent | d9d627cdf0507e44f606519384fbebd726eb0593 (diff) | |
refactor(tvix): build Rust projects using crate2nix r/5420
Introduces granular dependency builds using crate2nix, bootstrapped off the generated configuration from the newly introduced workspace (see cl/7533). This commit checks in the generated Cargo.nix file which can be regenerated with a parameterless invocation of `crate2nix generate` in `//tvix`. I tried generating this in IFD, but it turned out to be harder than what seemed worthwhile for now. In this setup, the various build targets for Rust projects end up being attributes of the imported `Cargo.nix` file at the `tvix.crates` attribute. These still lack configuration, however, which has been fixed in the various `default.nix` files of individual projects. Note that we (temporarily) lose the ability to build tvix-eval's benchmarks in CI. I haven't figured out what magic incantation summons them from the void again ... The `eval-okay-readDir` tests from both test suites have been disabled because they fail for unknown reasons when run in this new derivation. Somebody will have to debug it! Change-Id: I2014614ccb9c8951aedbd71df7966ca191a13695 Reviewed-on: https://cl.tvl.fyi/c/depot/+/7538 Autosubmit: tazjin <tazjin@tvl.su> Reviewed-by: flokli <flokli@flokli.de> Tested-by: BuildkiteCI
Diffstat (limited to 'tvix/README.md')
| -rw-r--r-- | tvix/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/tvix/README.md b/tvix/README.md index 9569cedf33f4..2a482097042e 100644 --- a/tvix/README.md +++ b/tvix/README.md @@ -6,6 +6,23 @@ are interested in people who would like to help us review designs, brainstorm and describe requirements that we may not yet have considered. +## Rust projects + +Some parts of Tvix are written in Rust. To simplify the dependency +management on the Nix side of these builds, we use `crate2nix` in a +single Rust workspace in `//tvix` to maintain the Nix build +configuration. + +When making changes to Cargo dependency configuration in any of the +Rust projects under `//tvix`, be sure to run `crate2nix generate` in +`//tvix` itself and commit the changes to the generated `Cargo.nix` +file. + +`crate2nix` is available via `direnv` inside of depot, or can be built +from the `third_party.nixpkgs.crate2nix` attribute of depot. Make sure +to build it from depot to avoid generating files with a different +version that might have different output. + ## License structure All code implemented for Tvix is licensed under the GPL-3.0, with the |