From 3fd1263d80c282796a57925550840b509cce2b1e Mon Sep 17 00:00:00 2001
From: Stephen Seo <seo.disparate@gmail.com>
Date: Mon, 20 Mar 2023 14:48:33 +0900
Subject: [PATCH] Add notes about `link_cargo_registry`

---
 README.md           | 9 +++++++++
 example_config.toml | 1 +
 2 files changed, 10 insertions(+)

diff --git a/README.md b/README.md
index a83d252..d043047 100644
--- a/README.md
+++ b/README.md
@@ -183,3 +183,12 @@ integrity checks are done separately.
 
 If the hook was used previously, remove it from `/etc/pacman.d/hooks` and
 reinstall `devtools`.
+
+## `link_cargo_registry`
+
+If you have `.cargo/registry` and `.cargo/git` in your home directory, and you
+don't want to re-download the Rust registry every time you update a Rust
+package, you can specify `link_cargo_registry = true` for a package in your
+config (see `ion-git` in the `example_config.toml`) and that will bind-mount
+these two directories into the chroot, which will share your local Rust cache
+with the chroot.
diff --git a/example_config.toml b/example_config.toml
index c721e85..1b96c14 100644
--- a/example_config.toml
+++ b/example_config.toml
@@ -98,6 +98,7 @@ skip_branch_up_to_date = true
 
 [[entry]]
 name = "ion-git"
+link_cargo_registry = true
 
 [[entry]]
 name = "ly"