docs: document how to install a suitable `josh-proxy` locally

Co-authored-by: Boxy <rust@boxyuwu.dev>
This commit is contained in:
许杰友 Jieyou Xu (Joe) 2025-01-18 14:14:10 +08:00
parent c1b4cfaa96
commit 81e9f12d3b
1 changed files with 7 additions and 0 deletions

View File

@ -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