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

54 lines
2.1 KiB
Markdown
Raw Normal View History

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
====
docs(tvix): link to IRC channel and mailing list I omitted the link to the commit history. Most people see this README through some git interface anyways, so it felt a bit redundant. Change-Id: I92cf6d08b83ef680fe37df29d3d546cad020955a Reviewed-on: https://cl.tvl.fyi/c/depot/+/7888 Reviewed-by: tazjin <tazjin@tvl.su> Reviewed-by: sterni <sternenseemann@systemli.org> Tested-by: BuildkiteCI Autosubmit: flokli <flokli@flokli.de>
2023-01-21 12:46:29 +01:00
For more information about Tvix, feel free to reach out.
We are interested in people who would like to help us review designs,
brainstorm and describe requirements that we may not yet have considered.
Most of the discussion around development happens on our IRC channel, which
you can join in several ways documented on
[tvl.fyi](https://tvl.fyi/#getting-in-touch).
There's also some discussion around development on our
[mailing list](https://inbox.tvl.su).
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
docs(tvix): move most of //tvix/eval README up to //tvix While moving the CLI out of the evaluator, we forgot to update the README in //tvix/eval. Move this up to //tvix, so people know where to start. Keep the instructions on how to build only `//tvix/eval` in `//tvix/ eval/README.md`. Change-Id: Ie2755e8b5a0056225dbf3a0ee040f70f7f6a1f27 Reviewed-on: https://cl.tvl.fyi/c/depot/+/7887 Reviewed-by: sterni <sternenseemann@systemli.org> Autosubmit: flokli <flokli@flokli.de> Tested-by: BuildkiteCI Reviewed-by: tazjin <tazjin@tvl.su>
2023-01-21 12:37:54 +01:00
## Building the CLI
If you are in a full checkout of the TVL depot, you can simply run `mg build`
in the `cli` directory (or `mg build //tvix/cli` from anywhere in the repo).
The `mg` command is found in `/tools/magrathea`.
**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 CLI can also be built with standard Rust tooling (i.e. `cargo build`),
as long as you are in a shell with the right dependencies (provided by `mg
shell //tvix:shell`).
## Rust projects, crate2nix
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
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
feat(tvix): add crate2nixGenerate target `mg run //tvix:crate2nixGenerate --` runs crate2nix generate and depotfmt's it afterwards. This removes a frequent point of friction, because the Cargo.nix emitted by crate2nix needs another formatter. Change-Id: I649495980718cd3847d4cff77c9d4bfcb599387c Reviewed-on: https://cl.tvl.fyi/c/depot/+/7612 Tested-by: BuildkiteCI Reviewed-by: grfn <grfn@gws.fyi>
2022-12-22 15:44:32 +01:00
Rust projects under `//tvix`, be sure to run
`mg run //tvix:crate2nixGenerate --` in `//tvix` itself and commit the changes
to the generated `Cargo.nix` file.
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
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.
Reference in a new issue Copy permalink