Skip to content

Commit 13bc083

Browse files
authored
Merge pull request #514 from rylev/clarify-rollup
Clarify rollup meanings
2 parents ca0fd67 + fe15965 commit 13bc083

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
@@ -117,7 +117,9 @@ reviewers to act quickly and gives you time to address the issue fully.
117117
## Rollups
118118

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

122124
- `rollup=always`: These PRs are very unlikely to break tests or have performance
123125
implications. Example scenarios:
@@ -127,12 +129,12 @@ not it should be part of a [rollup] with one of the following:
127129
- Your PR is not landing possibly-breaking or behavior altering changes.
128130
- Feature stabilization without other changes is likely fine to
129131
rollup, though.
130-
- `rollup=maybe`: This is the **default** if you do not specify a rollup
131-
status. Use this if you don't have much confidence that it won't break
132-
tests. This can be used if you aren't sure if it should be one of the other
133-
categories. Since this is the default, there is usually no need to
134-
explicitly specify this, unless you are un-marking the rollup level from a
135-
previous command.
132+
- When in doubt do not use this option!
133+
- `rollup=maybe`: This is the default if `@bors r+` does not specify any rollup
134+
status at all. Use this if you have some doubt that the change won't break
135+
tests. This can be used if you aren't sure if it should be one of the other
136+
categories. Since this is the default, there is usually no need to explicitly
137+
specify this, unless you are un-marking the rollup level from a previous command.
136138
- `rollup=iffy`: Use this for mildly risky PRs (more risky than "maybe").
137139
Example scenarios:
138140
- The PR is large and non-additive (note: adding 2000 lines of completely
@@ -151,10 +153,8 @@ not it should be part of a [rollup] with one of the following:
151153
rollup).
152154
- Has a high chance of failure.
153155
- Is otherwise dangerous to rollup.
154-
155-
> **Note**:\
156-
> `@bors rollup` is equivalent to `@bors rollup=always`\
157-
> `@bors rollup-` is equivalent to `@bors rollup=never`
156+
- `rollup`: this is equivalent to `rollup=always`
157+
- `rollup-`: this is equivalent to `rollup=maybe`
158158

159159
## Priority
160160

0 commit comments

Comments
 (0)