mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
tvl-depot/tvix
History
Vincent Ambo 5095e4f269 feat(tvix/eval): add generator "name" to NativeError kind 
This produces traces in which we can see what kind of native code was
run. Note that these "names" are named after the generator message, so
these aren't *really* intended for end-user consumption, but we can
give them saner names later.

Example:
https://gist.github.com/tazjin/82b24e92ace8e821008954867ee05057

This already makes the traces a little easier to parse.

Change-Id: Idcd601baf84f492211b732ea0f04b377112e10d0
Reviewed-on: https://cl.tvl.fyi/c/depot/+/8268
Reviewed-by: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
Autosubmit: tazjin <tazjin@tvl.su>
2023-03-17 19:31:37 +00:00
..
.vscode chore(tvix): fix vscode rust-analyzer recommendation 2022-10-15 16:54:28 +00:00
cli fix(tvix/cli): populate output configuration after walking args 2023-03-15 13:05:53 +00:00
docs docs(tvix): fix minor spelling problems in pointer equality document 2023-01-25 14:30:50 +00:00
eval feat(tvix/eval): add generator "name" to NativeError kind 2023-03-17 19:31:37 +00:00
nix-compat refactor(tvix/nix-compat): remove get_fixed_output() func 2023-03-15 15:31:55 +00:00
nix_cli chore(tvix): upgrade to clap 4.0 2022-12-21 13:23:38 +00:00
proto chore(tvix/store): move castore.proto 2022-12-04 10:41:39 +00:00
serde fix(tvix/eval): implement cppnix JSON-serialisation semantics 2023-03-13 20:30:59 +00:00
store refactor(tvix/store/nar): pass in &proto::node::Node 2023-03-17 07:49:38 +00:00
verify-lang-tests test(tvix/eval): add test for builtins parity 2023-01-06 12:00:38 +00:00
website feat(tvix): add simple initial website 2023-03-14 21:59:40 +00:00
.gitignore feat(tvix/): .gitignore target folders 2022-11-11 19:55:12 +00:00
Cargo.lock chore(tvix): run cargo update 2023-03-16 13:44:57 +00:00
Cargo.nix chore(tvix): run cargo update 2023-03-16 13:44:57 +00:00
Cargo.toml refactor(tvix/nix-compat): absorb nar writer 2023-01-31 15:18:39 +00:00
crate-hashes.json fix(tvix/cli): use tvlfyi/wu-manber fork for refscanner 2023-02-04 12:44:59 +00:00
default.nix chore(tvix/store): drop separate bin package 2023-03-14 22:23:10 +00:00
LICENSE chore(tvix): Bootstrap Tvix folder 2021-03-27 00:09:49 +00:00
OWNERS chore(gerrit): migrate OWNERS files to code-owners style 2022-09-19 11:13:28 +00:00
README.md style(tvix): add new logo to the Tvix README 2023-03-14 22:44:18 +00:00

README.md

Tvix is a new implementation of the Nix language and package manager. See the announcement post for information about the background of this project.

Tvix is developed by TVL in our monorepo, the depot, at //tvix. Code reviews take place on Gerrit, bugs are filed in our issue tracker.

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, or on our mailing list.

Contributions to Tvix follow the TVL review flow and contribution guidelines.

WARNING: Tvix is not ready for use in production. None of our current APIs should be considered stable in any way.

WARNING: Any other instances of this project or repository are josh-mirrors. We do not accept code contributions or issues outside of the tooling and communication methods outlined above.

Components

This folder contains the following components:

  • //tvix/eval - an implementation of the Nix programming language
  • //tvix/nix-compat - library functions for compatibility with C++ Nix
  • //tvix/cli - preliminary REPL & CLI implementation for Tvix
  • //tvix/serde - Rust library for using the Nix language for app configuration
  • //tvix/store - implementation of a file store for Tvix

Some additional folders with auxiliary things exist and can be explored at your leisure.

Building the CLI

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.

  • If you cloned the full monorepo, it can be provided by mg shell //tvix:shell.
  • If you cloned the tvix workspace only (git clone https://code.tvl.fyi/depot.git:workspace=views/tvix.git), nix-shell provides it.

If you're in the TVL monorepo, you can also run mg build //tvix/cli (or mg build from inside that folder) for a more incremental build.

Please follow the depot-wide instructions on how to get mg and use the depot tooling.

Compatibility

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.

Rust projects, crate2nix

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 mg run //tvix:crate2nixGenerate -- in //tvix itself and commit the changes to the generated Cargo.nix file. This only applies to the full TVL checkout.

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.