Skip to content

Commit 9f8a854

Browse files
committed
Reflow perf chapter
1 parent 0c18a9e commit 9f8a854

File tree

1 file changed

+24
-23
lines changed

1 file changed

+24
-23
lines changed

src/tests/perf.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@
44

55
A lot of work is put into improving the performance of the compiler and
66
preventing performance regressions.
7+
78
The [rustc-perf](https://github.com/rust-lang/rustc-perf) project provides
8-
several services for testing and tracking performance.
9-
It provides hosted infrastructure for running benchmarks as a service.
10-
At this time, only `x86_64-unknown-linux-gnu` builds are tracked.
9+
several services for testing and tracking performance. It provides hosted
10+
infrastructure for running benchmarks as a service. At this time, only
11+
`x86_64-unknown-linux-gnu` builds are tracked.
1112

1213
A "perf run" is used to compare the performance of the compiler in different
13-
configurations for a large collection of popular crates.
14-
Different configurations include "fresh builds", builds with incremental compilation, etc.
14+
configurations for a large collection of popular crates. Different
15+
configurations include "fresh builds", builds with incremental compilation, etc.
1516

1617
The result of a perf run is a comparison between two versions of the compiler
1718
(by their commit hashes).
@@ -24,30 +25,29 @@ Any changes are noted in a comment on the PR.
2425

2526
### Manual perf runs
2627

27-
Additionally, performance tests can be ran before a PR is merged on an as-needed basis.
28-
You should request a perf run if your PR may affect performance, especially if
29-
it can affect performance adversely.
28+
Additionally, performance tests can be ran before a PR is merged on an as-needed
29+
basis. You should request a perf run if your PR may affect performance,
30+
especially if it can affect performance adversely.
3031

3132
To evaluate the performance impact of a PR, write this comment on the PR:
3233

3334
`@bors try @rust-timer queue`
3435

35-
> **Note**: Only users authorized to do perf runs are allowed to post this comment.
36-
> Teams that are allowed to use it are tracked in the [Teams
37-
> repository](https://github.com/rust-lang/team) with the `perf = true` value
38-
> in the `[permissions]` section (and bors permissions are also required).
39-
> If you are not on one of those teams, feel free to ask for someone to post
40-
> it for you (either on Zulip or ask the assigned reviewer).
36+
> **Note**: Only users authorized to do perf runs are allowed to post this
37+
> comment. Teams that are allowed to use it are tracked in the [Teams
38+
> repository](https://github.com/rust-lang/team) with the `perf = true` value in
39+
> the `[permissions]` section (and bors permissions are also required). If you
40+
> are not on one of those teams, feel free to ask for someone to post it for you
41+
> (either on Zulip or ask the assigned reviewer).
4142
42-
This will first tell bors to do a "try" build which do a full release build
43-
for `x86_64-unknown-linux-gnu`.
44-
After the build finishes, it will place it in the queue to run the performance
45-
suite against it.
46-
After the performance tests finish, the bot will post a comment on the PR with
47-
a summary and a link to a full report.
43+
This will first tell bors to do a "try" build which do a full release build for
44+
`x86_64-unknown-linux-gnu`. After the build finishes, it will place it in the
45+
queue to run the performance suite against it. After the performance tests
46+
finish, the bot will post a comment on the PR with a summary and a link to a
47+
full report.
4848

49-
If you want to do a perf run for an already built artifact (e.g. for a previous try
50-
build that wasn't benchmarked yet), you can run this instead:
49+
If you want to do a perf run for an already built artifact (e.g. for a previous
50+
try build that wasn't benchmarked yet), you can run this instead:
5151

5252
`@rust-timer build <commit-sha>`
5353

@@ -56,5 +56,6 @@ You cannot benchmark the same artifact twice though.
5656
More information about the available perf bot commands can be found
5757
[here](https://perf.rust-lang.org/help.html).
5858

59-
More details about the benchmarking process itself are available in the [perf collector
59+
More details about the benchmarking process itself are available in the [perf
60+
collector
6061
documentation](https://github.com/rust-lang/rustc-perf/blob/master/collector/README.md).

0 commit comments

Comments
 (0)