Skip to content

Commit 4397b6b

Browse files
committed
Auto merge of rust-lang#3438 - RalfJung:josh, r=RalfJung
update josh version and guidance
2 parents 5730fc5 + e25c624 commit 4397b6b

File tree

3 files changed

+9
-13
lines changed

3 files changed

+9
-13
lines changed

src/tools/miri/.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ jobs:
195195
with:
196196
fetch-depth: 256 # get a bit more of the history
197197
- name: install josh-proxy
198-
run: RUSTFLAGS="--cap-lints warn" cargo +stable install josh-proxy --git https://github.com/josh-project/josh --tag r22.12.06
198+
run: RUSTFLAGS="--cap-lints warn" cargo +stable install josh-proxy --git https://github.com/josh-project/josh --tag r23.12.04
199199
- name: setup bot git name and email
200200
run: |
201201
git config --global user.name 'The Miri Cronjob Bot'

src/tools/miri/CONTRIBUTING.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -241,18 +241,20 @@ We use the [`josh` proxy](https://github.com/josh-project/josh) to transmit chan
241241
rustc and Miri repositories. You can install it as follows:
242242

243243
```sh
244-
cargo +stable install josh-proxy --git https://github.com/josh-project/josh --tag r22.12.06
244+
RUSTFLAGS="--cap-lints=warn" cargo +stable install josh-proxy --git https://github.com/josh-project/josh --tag r23.12.04
245245
```
246246

247247
Josh will automatically be started and stopped by `./miri`.
248248

249249
### Importing changes from the rustc repo
250250

251+
*Note: this usually happens automatically, so these steps rarely have to be done by hand.*
252+
251253
We assume we start on an up-to-date master branch in the Miri repo.
252254

253255
```sh
254256
# Fetch and merge rustc side of the history. Takes ca 5 min the first time.
255-
# This will also update the 'rustc-version' file.
257+
# This will also update the `rustc-version` file.
256258
./miri rustc-pull
257259
# Update local toolchain and apply formatting.
258260
./miri toolchain && ./miri fmt
@@ -266,12 +268,6 @@ needed.
266268

267269
### Exporting changes to the rustc repo
268270

269-
Keep in mind that pushing is the most complicated job that josh has to do -- pulling just filters
270-
the rustc history, but pushing needs to construct a new rustc history that would filter to the given
271-
Miri history! To avoid problems, it is a good idea to always pull immediately before you push. If
272-
you are getting strange errors, chances are you are running into [this josh
273-
bug](https://github.com/josh-project/josh/issues/998). In that case, please get in touch on Zulip.
274-
275271
We will use the josh proxy to push to your fork of rustc. Run the following in the Miri repo,
276272
assuming we are on an up-to-date master branch:
277273

@@ -280,9 +276,9 @@ assuming we are on an up-to-date master branch:
280276
./miri rustc-push YOUR_NAME miri
281277
```
282278

283-
This will create a new branch called 'miri' in your fork, and the output should
284-
include a link to create a rustc PR that will integrate those changes into the
285-
main repository.
279+
This will create a new branch called `miri` in your fork, and the output should include a link that
280+
creates a rustc PR to integrate those changes into the main repository. If that PR has conflicts,
281+
you need to pull rustc changes into Miri first, and then re-do the rustc push.
286282

287283
If this fails due to authentication problems, it can help to make josh push via ssh instead of
288284
https. Add the following to your `.gitconfig`:

src/tools/miri/miri-script/src/commands.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ impl Command {
297297
};
298298
// Prepare the branch. Pushing works much better if we use as base exactly
299299
// the commit that we pulled from last time, so we use the `rust-version`
300-
// file as a good approximation of that.
300+
// file to find out which commit that would be.
301301
println!("Preparing {github_user}/rust (base: {base})...");
302302
if cmd!(sh, "git fetch https://github.com/{github_user}/rust {branch}")
303303
.ignore_stderr()

0 commit comments

Comments
 (0)