tvl-depot/docs/designs/SPARSE_CHECKOUTS.md
Vincent Ambo c6cb138565 chore(tools): remove depot-scanner & tvlc
These are both unused things from a long time ago, which we don't need
to keep around anymore.

Their design doc has been marked as archived.

Change-Id: Icd2744e511e78ec95ec8f39e5f79ed1fe98e9e4a
Reviewed-on: https://cl.tvl.fyi/c/depot/+/7639
Autosubmit: tazjin <tazjin@tvl.su>
Tested-by: BuildkiteCI
Reviewed-by: flokli <flokli@flokli.de>
2022-12-26 11:16:39 +00:00

1.4 KiB

NOTE: This proposal is archived. We run josh instead, and long-term might want to integrate per-target dependency analysis with josh's workspace functionality.


Below is a prototype for a script to create Git sparse checkouts of the depot. The script below works today with relatively recent versions of git.

Open items:

  • Read-increment-write the checkout ID from a file in .git.
  • NICE_CHECKOUT_ROOT should be a git configuration value.
  • tvl-get-depends will be a script that contacts the build farm and asks for the closure of a given source directory, using depot-scan.
DEPOT_ROOT="${depot.path}"
XDG_DATA_HOME="${XDG_DATA_HOME:-$HOME/.local/share}"
CLIENT_ROOT="$XDG_DATA_HOME/tvlc/clients"
NICE_CHECKOUT_ROOT="$HOME/tvlc"
CHECKOUT_ID=1
CHECKOUT_NAME=myclient # command line variables

assertAbsolutePath "$CLIENT_ROOT"

mkdir "$CLIENT_ROOT"/"$CHECKOUT_ID"
ln -s "$CLIENT_ROOT"/"$CHECKOUT_ID" "$NICE_CHECKOUT_ROOT"/"$CHECKOUT_NAME"

cd "$DEPOT_ROOT"
git worktree add --no-checkout -b "tvlc-$CHECKOUT_ID" "$CLIENT_ROOT/$CHECKOUT_ID/" canon
# BUG: git not creating the /info/ subdir
mkdir "$DEPOT_ROOT"/.git/worktrees/"$CHECKOUT_ID"/info

cd "$CLIENT_ROOT/$CHECKOUT_ID"
git sparse-checkout init --cone
git sparse-checkout set "$TARGET_DIR" nix/readTree overrides
tvl-get-depends "$TARGET_DIR" | xargs git sparse-checkout add

cd "$NICE_CHECKOUT_ROOT"/"$CHECKOUT_NAME"