Skip to content

Commit 2d5a47f

Browse files
JohnTitormark-i-m
authored andcommitted
Add guidance for making a PR fixes toolstate
1 parent 733c435 commit 2d5a47f

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,17 @@ when you run `mdbook build`.
6464

6565
10. Fix those links in the rustc-guide (by making a PR in the rustc-guide repo)
6666

67-
11. Make a PR on the rust-lang/rust repo to update the rustc-guide git submodule in src/docs/rustc-guide
67+
11. Make a PR on the rust-lang/rust repo to update the rustc-guide git submodule in src/docs/rustc-guide.
68+
To make a PR, the following steps are useful.
69+
70+
```bash
71+
# Assuming you already cloned the rust-lang/rust repo and you're in the correct directory
72+
git submodule update --remote src/doc/rustc-guide
73+
git add -u
74+
git commit -m "Update rustc-guide"
75+
./x.py test -i --stage 1 src/doc/rustc-guide # This is optional and should succeed anyway
76+
# Open a PR in rust-lang/rust
77+
```
6878

6979
12. Wait for PR to merge
7080

0 commit comments

Comments
 (0)