about summary refs log tree commit diff
path: root/tvix
diff options
context:
space:
mode:
authorAdam Joseph <adam@westernsemico.com>2022-10-12T05·12-0700
committerAdam Joseph <adam@westernsemico.com>2022-10-13T18·41+0000
commitd4bc58b38d4ff5a58ea92f1ae8ac9c1290e1c741 (patch)
treec3c85c9f7fa3b9eb47105c5618c26543ea1a3c60 /tvix
parenta545f21cc0ec279be5e128bcbb2ab822787579dc (diff)
docs(tvix/eval): explain where to find the site-specific `mg` tool r/5126
When I first read the `README.md` I didn't know what this `mg build`
was.  Some grepping around turned up `/tools/magrathea`.  Apparently
this thing "helps me build planets".  Awesome!  Let's tell other
people where to find it.  It seems that this tool is (currently)
specific to depot, so people who arrive at depot because of tvix
probably won't know where to find `mg`.

Signed-off-by: Adam Joseph <adam@westernsemico.com>
Change-Id: Icb8c51087fd41b696794516abcfee24a4b3b4a14
Reviewed-on: https://cl.tvl.fyi/c/depot/+/6948
Reviewed-by: tazjin <tazjin@tvl.su>
Tested-by: tazjin <tazjin@tvl.su>
Diffstat (limited to 'tvix')
-rw-r--r--tvix/eval/README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/tvix/eval/README.md b/tvix/eval/README.md
index dfd000e902b6..1f19ceb0e5ed 100644
--- a/tvix/eval/README.md
+++ b/tvix/eval/README.md
@@ -19,7 +19,7 @@ have.
 
 If you are in a full checkout of the TVL depot, you can simply run `mg
 build` in this directory (or `mg build //tvix/eval` from anywhere in
-the repo).
+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