about summary refs log tree commit diff
path: root/tvix/README.md
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2022-12-22T14·44+0100
committerflokli <flokli@flokli.de>2022-12-22T15·26+0000
commit40a17acdc11a7bbd45cde834e41c42ba04f4628d (patch)
treee65db739f9d1d7580de1fc1be42f59ad4771d359 /tvix/README.md
parent2e04f68df8c69034151cce5b56ceedb0653687cd (diff)
feat(tvix): add crate2nixGenerate target r/5472
`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>
Diffstat (limited to 'tvix/README.md')
-rw-r--r--tvix/README.md11
1 files changed, 3 insertions, 8 deletions
diff --git a/tvix/README.md b/tvix/README.md
index 2a482097042e..e06b59bef9e7 100644
--- a/tvix/README.md
+++ b/tvix/README.md
@@ -14,14 +14,9 @@ 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.
+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.
 
 ## License structure