From d290423947bed57e8f93b948311d3d079c454ec7 Mon Sep 17 00:00:00 2001 From: Yuki Okushi Date: Thu, 19 Sep 2019 00:14:59 +0900 Subject: [PATCH] Add guidance for making a PR fixes toolstate --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fc9a06a8..42e7e44a 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,17 @@ when you run `mdbook build`. 10. Fix those links in the rustc-guide (by making a PR in the rustc-guide repo) -11. Make a PR on the rust-lang/rust repo to update the rustc-guide git submodule in src/docs/rustc-guide +11. Make a PR on the rust-lang/rust repo to update the rustc-guide git submodule in src/docs/rustc-guide. +To make a PR, the following steps are useful. + +```bash +# Assuming you already cloned the rust-lang/rust repo and you're in the correct directory +git submodule update --remote src/doc/rustc-guide +git add -u +git commit -m "Update rustc-guide" +./x.py test -i --stage 1 src/doc/rustc-guide # This is optional and should succeed anyway +# Open a PR in rust-lang/rust +``` 12. Wait for PR to merge