Skip to content

Commit 412e81b

Browse files
committed
Update CONTRIBUTING.md
1 parent 53f80b8 commit 412e81b

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -297,25 +297,27 @@ You can also directly run Miri on a Rust source file:
297297

298298
## Advanced topic: Syncing with the rustc repo
299299

300-
We use the [`josh` proxy](https://github.com/josh-project/josh) to transmit changes between the
300+
We use the [`josh-sync`](https://github.com/rust-lang/josh-sync) tool to transmit changes between the
301301
rustc and Miri repositories. You can install it as follows:
302302

303303
```sh
304-
cargo +stable install josh-proxy --git https://github.com/josh-project/josh --tag r24.10.04
304+
cargo install --locked --git https://github.com/rust-lang/josh-sync
305305
```
306306

307-
Josh will automatically be started and stopped by `./miri`.
307+
[Josh](https://github.com/josh-project/josh) will automatically be started and stopped by the commands below.
308308

309309
### Importing changes from the rustc repo
310310

311311
*Note: this usually happens automatically, so these steps rarely have to be done by hand.*
312312

313313
We assume we start on an up-to-date master branch in the Miri repo.
314314

315+
1) First, create a branch for the pull, e.g. `git checkout -b rustc-pull`
316+
2) Then run the following:
315317
```sh
316318
# Fetch and merge rustc side of the history. Takes ca 5 min the first time.
317319
# This will also update the `rustc-version` file.
318-
./miri rustc-pull
320+
rustc-josh-sync pull
319321
# Update local toolchain and apply formatting.
320322
./miri toolchain && ./miri fmt
321323
git commit -am "rustup"
@@ -328,12 +330,12 @@ needed.
328330

329331
### Exporting changes to the rustc repo
330332

331-
We will use the josh proxy to push to your fork of rustc. Run the following in the Miri repo,
333+
We will use the `josh-sync` tool to push to your fork of rustc. Run the following in the Miri repo,
332334
assuming we are on an up-to-date master branch:
333335

334336
```sh
335337
# Push the Miri changes to your rustc fork (substitute your github handle for YOUR_NAME).
336-
./miri rustc-push YOUR_NAME miri
338+
rustc-josh-sync push YOUR_NAME miri
337339
```
338340

339341
This will create a new branch called `miri` in your fork, and the output should include a link that

0 commit comments

Comments
 (0)