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

105 lines
4 KiB
Markdown
Raw Normal View History

style(tvix): add new logo to the Tvix README Change-Id: Ibb8061be75d6fd16e8f813bc94e3bacaae890454 Reviewed-on: https://cl.tvl.fyi/c/depot/+/8309 Tested-by: BuildkiteCI Autosubmit: tazjin <tazjin@tvl.su> Reviewed-by: flokli <flokli@flokli.de>
2023-03-14 23:41:00 +01:00
<div align="center">
<img src="https://tvix.dev/tvix-logo.webp">
</div>
-----------------
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): add more information to README The README was very sparse before and we've actually had people email us (as it says to contact us) just to ask what Tvix *is*. This should answer some questions! Change-Id: I0f248cb060eccfe086468afed1d648652b35dfd1 Reviewed-on: https://cl.tvl.fyi/c/depot/+/8018 Tested-by: BuildkiteCI Autosubmit: tazjin <tazjin@tvl.su> Reviewed-by: flokli <flokli@flokli.de>
2023-02-02 16:01:46 +01:00
Tvix is a new implementation of the Nix language and package manager. See the
[announcement post][post-1] for information about the background of this
project.
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
docs(tvix): add more information to README The README was very sparse before and we've actually had people email us (as it says to contact us) just to ask what Tvix *is*. This should answer some questions! Change-Id: I0f248cb060eccfe086468afed1d648652b35dfd1 Reviewed-on: https://cl.tvl.fyi/c/depot/+/8018 Tested-by: BuildkiteCI Autosubmit: tazjin <tazjin@tvl.su> Reviewed-by: flokli <flokli@flokli.de>
2023-02-02 16:01:46 +01:00
Tvix is developed by [TVL][tvl] in our monorepo, the `depot`, at
[//tvix][tvix-src]. Code reviews take place on [Gerrit][tvix-gerrit], bugs are
filed in [our issue tracker][b].
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
docs(tvix): add more information to README The README was very sparse before and we've actually had people email us (as it says to contact us) just to ask what Tvix *is*. This should answer some questions! Change-Id: I0f248cb060eccfe086468afed1d648652b35dfd1 Reviewed-on: https://cl.tvl.fyi/c/depot/+/8018 Tested-by: BuildkiteCI Autosubmit: tazjin <tazjin@tvl.su> Reviewed-by: flokli <flokli@flokli.de>
2023-02-02 16:01:46 +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][getting-in-touch], or on our
[mailing list][].
Contributions to Tvix follow the TVL [review flow][review-docs] and
[contribution guidelines][contributing].
[post-1]: https://tvl.fyi/blog/rewriting-nix
[tvl]: https://tvl.fyi
[tvix-src]: https://cs.tvl.fyi/depot/-/tree/tvix/
[tvix-gerrit]: https://cl.tvl.fyi/q/path:%255Etvix.*
[b]: https://b.tvl.fyi
[getting-in-touch]: https://tvl.fyi/#getting-in-touch
[mailing list]: https://inbox.tvl.su
[review-docs]: https://code.tvl.fyi/about/docs/REVIEWS.md
[contributing]: https://code.tvl.fyi/about/docs/CONTRIBUTING.md
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][josh]. We do not accept code contributions or issues outside of
the tooling and communication methods outlined above.
[josh]: https://github.com/josh-project/josh
## 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.
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
docs(tvix): update README to document usage inside tvix view If the tvix view is cloned through josh, you don't use mg, but a `shell.nix` is provided. Also, add the `git clone` command, so people browsing tvix source code in the browser know where to clone from. Change-Id: I18483d6a52953f9f4eafd1533ea69afb0e329b04 Reviewed-on: https://cl.tvl.fyi/c/depot/+/8001 Reviewed-by: tazjin <tazjin@tvl.su> Tested-by: BuildkiteCI
2023-02-01 14:38:43 +01:00
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.
docs(tvix): move mg shell command into one line This was reflowed in a funny way. Move the whole command into its own line, to prevent it from happening. Change-Id: Ifba4daf418487ca4c32586820071930d29020f42 Reviewed-on: https://cl.tvl.fyi/c/depot/+/8026 Autosubmit: flokli <flokli@flokli.de> Tested-by: BuildkiteCI Reviewed-by: tazjin <tazjin@tvl.su>
2023-02-03 13:03:59 +01:00
- If you cloned the full monorepo, it can be provided by
`mg shell //tvix:shell`.
docs(tvix): update README to document usage inside tvix view If the tvix view is cloned through josh, you don't use mg, but a `shell.nix` is provided. Also, add the `git clone` command, so people browsing tvix source code in the browser know where to clone from. Change-Id: I18483d6a52953f9f4eafd1533ea69afb0e329b04 Reviewed-on: https://cl.tvl.fyi/c/depot/+/8001 Reviewed-by: tazjin <tazjin@tvl.su> Tested-by: BuildkiteCI
2023-02-01 14:38:43 +01:00
- 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.
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
docs(tvix): update README to document usage inside tvix view If the tvix view is cloned through josh, you don't use mg, but a `shell.nix` is provided. Also, add the `git clone` command, so people browsing tvix source code in the browser know where to clone from. Change-Id: I18483d6a52953f9f4eafd1533ea69afb0e329b04 Reviewed-on: https://cl.tvl.fyi/c/depot/+/8001 Reviewed-by: tazjin <tazjin@tvl.su> Tested-by: BuildkiteCI
2023-02-01 14:38:43 +01:00
Please follow the depot-wide instructions on how to get `mg` and use the depot
tooling.
### Compatibility
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
**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
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
docs(tvix): update README to document usage inside tvix view If the tvix view is cloned through josh, you don't use mg, but a `shell.nix` is provided. Also, add the `git clone` command, so people browsing tvix source code in the browser know where to clone from. Change-Id: I18483d6a52953f9f4eafd1533ea69afb0e329b04 Reviewed-on: https://cl.tvl.fyi/c/depot/+/8001 Reviewed-by: tazjin <tazjin@tvl.su> Tested-by: BuildkiteCI
2023-02-01 14:38:43 +01:00
to the generated `Cargo.nix` file. This only applies to the full TVL checkout.
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