@@ -30,7 +30,9 @@ to approve the PR by issuing `@bors` commands like the ones above
30
30
## Rollups
31
31
32
32
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:
34
36
35
37
- ` rollup=always ` : These PRs are very unlikely to break tests or have performance
36
38
implications. Example scenarios:
@@ -40,12 +42,12 @@ not it should be part of a [rollup] with one of the following:
40
42
- Your PR is not landing possibly-breaking or behavior altering changes.
41
43
- Feature stabilization without other changes is likely fine to
42
44
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.
49
51
- ` rollup=iffy ` : Use this for mildly risky PRs (more risky than "maybe").
50
52
Example scenarios:
51
53
- 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:
64
66
rollup).
65
67
- Has a high chance of failure.
66
68
- 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 `
71
71
72
72
## Priority
73
73
0 commit comments