about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
author许杰友 Jieyou Xu (Joe) <39484203+jieyouxu@users.noreply.github.com>2025-01-20 12:36:25 +0800
committerGitHub <noreply@github.com>2025-01-20 12:36:25 +0800
commit24f264a50b58b1d1e18b4c487feb68196de5bd08 (patch)
tree6501c5cd11de311b6268a7cb1c91216c448bb63d /src/doc/rustc-dev-guide
parent84fdb5177e809c96b913b3477f42e5805cc2a037 (diff)
parentd6b0828d79a2cd7d87212d755d10c55eb1772a38 (diff)
downloadrust-24f264a50b58b1d1e18b4c487feb68196de5bd08.tar.gz
rust-24f264a50b58b1d1e18b4c487feb68196de5bd08.zip
Merge pull request #2213 from jieyouxu/install-josh-proxy
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/README.md b/src/doc/rustc-dev-guide/README.md
index 7ce7d4ddf3e..2464ffbbc50 100644
--- a/src/doc/rustc-dev-guide/README.md
+++ b/src/doc/rustc-dev-guide/README.md
@@ -74,6 +74,13 @@ including the `<!-- toc -->` marker at the place where you want the TOC.
 
 This repository is linked to `rust-lang/rust` as a [josh](https://josh-project.github.io/josh/intro.html) subtree. You can use the following commands to synchronize the subtree in both directions.
 
+You'll need to install `josh-proxy` locally via
+
+```
+cargo +stable install josh-proxy --git https://github.com/josh-project/josh --tag r24.10.04
+```
+Older versions of `josh-proxy` may not round trip commits losslessly so it is important to install this exact version.
+
 ### Pull changes from `rust-lang/rust` into this repository
 1) Checkout a new branch that will be used to create a PR into `rust-lang/rustc-dev-guide`
 2) Run the pull command