tvl-depot/tvix/README.md

Tvix
====

For more information about Tvix, contact one of the project owners. We
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
exception of the protocol buffer definitions used for communication
between services which are available under a more permissive license
(MIT).

The idea behind this structure is that any direct usage of our code
(e.g. linking to it, embedding the evaluator, etc.) will fall under
the terms of the GPL3, but users are free to implement their own
components speaking these protocols under the terms of the MIT
license.
chore(tvix): Bootstrap Tvix folder Change-Id: Ib4d4736c48a31510660b2861aabb9b7ef1320209 Reviewed-on: https://cl.tvl.fyi/c/depot/+/2684 Tested-by: BuildkiteCI Reviewed-by: flokli <flokli@flokli.de> 2021-03-26 23:49:32 +01:00			`Tvix`
			`====`

			`For more information about Tvix, contact one of the project owners. We`
			`are interested in people who would like to help us review designs,`
			`brainstorm and describe requirements that we may not yet have`
			`considered.`

refactor(tvix): build Rust projects using crate2nix 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 2022-12-07 12:05:02 +01:00			`## 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.`

chore(tvix): Bootstrap Tvix folder Change-Id: Ib4d4736c48a31510660b2861aabb9b7ef1320209 Reviewed-on: https://cl.tvl.fyi/c/depot/+/2684 Tested-by: BuildkiteCI Reviewed-by: flokli <flokli@flokli.de> 2021-03-26 23:49:32 +01:00			`## License structure`

			`All code implemented for Tvix is licensed under the GPL-3.0, with the`
			`exception of the protocol buffer definitions used for communication`
			`between services which are available under a more permissive license`
			`(MIT).`

			`The idea behind this structure is that any direct usage of our code`
			`(e.g. linking to it, embedding the evaluator, etc.) will fall under`
			`the terms of the GPL3, but users are free to implement their own`
			`components speaking these protocols under the terms of the MIT`
			`license.`