@@ -13,16 +13,20 @@ for a list of Miri maintainers.
13
13
14
14
[ Rust Zulip ] : https://rust-lang.zulipchat.com
15
15
16
- ### Pull review process
16
+ ### PR review process
17
17
18
18
When you get a review, please take care of the requested changes in new commits. Do not amend
19
19
existing commits. Generally avoid force-pushing. The only time you should force push is when there
20
20
is a conflict with the master branch (in that case you should rebase across master, not merge), and
21
21
all the way at the end of the review process when the reviewer tells you that the PR is done and you
22
- should squash the commits. If you are unsure how to use ` git rebase ` to squash commits, use `./miri
23
- squash` which automates the process but leaves little room for customization. (All this is to work
24
- around the fact that Github is quite bad at dealing with force pushes and does not support `git
25
- range-diff`. Maybe one day Github will be good at git and then life can become easier.)
22
+ should squash the commits. (All this is to work around the fact that Github is quite bad at
23
+ dealing with force pushes and does not support ` git range-diff ` .)
24
+
25
+ The recommended way to squash commits is to use ` ./miri squash ` , which will make everything into a
26
+ single commit. You will be asked for the commit message; please ensure it describes the entire PR.
27
+ You can also use ` git rebase ` manually if you need more control (e.g. if there should be more than
28
+ one commit at the end), but then please use ` --keep-base ` to ensure the PR remains based on the same
29
+ upstream commit.
26
30
27
31
Most PRs bounce back and forth between the reviewer and the author several times, so it is good to
28
32
keep track of who is expected to take the next step. We are using the ` S-waiting-for-review ` and
@@ -348,6 +352,7 @@ https. Add the following to your `.gitconfig`:
348
352
349
353
The following environment variables are relevant to ` ./miri ` :
350
354
355
+ * ` CARGO ` sets the binary used to execute Cargo; if none is specified, defaults to ` cargo ` .
351
356
* ` MIRI_AUTO_OPS ` indicates whether the automatic execution of rustfmt, clippy and toolchain setup
352
357
(as controlled by the ` ./auto-* ` files) should be skipped. If it is set to ` no ` , they are skipped.
353
358
This is used to allow automated IDE actions to avoid the auto ops.
0 commit comments