Skip to content

Commit 8ee1d91

Browse files
Markmark-i-m
authored andcommitted
add more on crater + perf runs
1 parent d0ad0c7 commit 8ee1d91

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

src/tests/intro.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,23 @@ While crater is really useful, it is also important to be aware of a few caveats
203203
that the crate doesn't compile any more (e.g. used old nightly features),
204204
has broken or flaky tests, requires network access, or other reasons.
205205

206+
- Before crater can be run, `@bors try` needs to suceed. This means that if
207+
your code doesn't compile or fails tests, you cannot run crater.
208+
209+
## Perf runs
210+
211+
A lot of work is put into improving the performance of the compiler and
212+
preventing performance regressions. A "perf run" is used to compare the
213+
performance of the compiler in different configurations for a large collection
214+
of popular crates. Different configurations include "fresh builds", builds
215+
with incremental compilation, etc.
216+
217+
The result of a perf run is a comparison between two versions of the
218+
compiler (by their commit hashes).
219+
220+
You should request a perf run if your PR may affect performance, especially
221+
if it can affect performance adversely.
222+
206223
## Further reading
207224

208225
The following blog posts may also be of interest:

0 commit comments

Comments
 (0)