Skip to content

Commit 4725c08

Browse files
committed
Clarify rollup meanings
1 parent e1eb075 commit 4725c08

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

src/compiler/reviews.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ to approve the PR by issuing `@bors` commands like the ones above
3030
## Rollups
3131

3232
All reviewers are strongly encouraged to explicitly mark a PR as to whether or
33-
not it should be part of a [rollup] with one of the following:
33+
not it should be part of a [rollup]. This is usually done either when approving a
34+
PR with `@bors r+ $ROLLUP_STATUS` or with `@bors $ROLLUP_STATUS` where `$ROLLUP_STATUS`
35+
is substituted with one of the following:
3436

3537
- `rollup=always`: These PRs are very unlikely to break tests or have performance
3638
implications. Example scenarios:
@@ -40,12 +42,12 @@ not it should be part of a [rollup] with one of the following:
4042
- Your PR is not landing possibly-breaking or behavior altering changes.
4143
- Feature stabilization without other changes is likely fine to
4244
rollup, though.
43-
- `rollup=maybe`: This is the **default** if you do not specify a rollup
44-
status. Use this if you don't have much confidence that it won't break
45-
tests. This can be used if you aren't sure if it should be one of the other
46-
categories. Since this is the default, there is usually no need to
47-
explicitly specify this, unless you are un-marking the rollup level from a
48-
previous command.
45+
- When in doubt do not use this option!
46+
- `rollup=maybe`: This is the default if `@bors r+` does not specify any rollup
47+
status at all. Use this if you have some doubt that the change won't break
48+
tests. This can be used if you aren't sure if it should be one of the other
49+
categories. Since this is the default, there is usually no need to explicitly
50+
specify this, unless you are un-marking the rollup level from a previous command.
4951
- `rollup=iffy`: Use this for mildly risky PRs (more risky than "maybe").
5052
Example scenarios:
5153
- The PR is large and non-additive (note: adding 2000 lines of completely
@@ -64,10 +66,8 @@ not it should be part of a [rollup] with one of the following:
6466
rollup).
6567
- Has a high chance of failure.
6668
- Is otherwise dangerous to rollup.
67-
68-
> **Note**:\
69-
> `@bors rollup` is equivalent to `@bors rollup=always`\
70-
> `@bors rollup-` is equivalent to `@bors rollup=never`
69+
- `rollup`: this is equivalent to `rollup=always`
70+
- `rollup-`: this is equivalent to `rollup=never`
7171

7272
## Priority
7373

0 commit comments

Comments
 (0)