Skip to content

Commit 7894dec

Browse files
committed
Mention codegen backends in help
1 parent 28742b5 commit 7894dec

File tree

1 file changed

+34
-21
lines changed

1 file changed

+34
-21
lines changed
Lines changed: 34 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,61 @@
11
{% extends "layout.html" %}
22
{% block head %}
33
<style>
4-
.help-content {
5-
font-family: Helvetica, Arial, sans-serif;
6-
line-height: 140%;
7-
font-size: 16px;
8-
max-width: 50em;
9-
}
4+
.help-content {
5+
font-family: Helvetica, Arial, sans-serif;
6+
line-height: 140%;
7+
font-size: 16px;
8+
max-width: 50em;
9+
}
1010

11-
.help-content code {
12-
background: #eee;
13-
border-radius: 5px;
14-
padding: 2px;
15-
}
11+
.help-content code {
12+
background: #eee;
13+
border-radius: 5px;
14+
padding: 2px;
15+
}
1616
</style>
1717
{% endblock %}
1818

1919
{% block content %}
2020
<div class="help-content">
2121
<h3><b><code>@rust-timer</code> commands</b></h3>
2222
<p><code>@rust-timer</code> supports several commands, the most common (and simple) being
23-
<code>@rust-timer queue</code>. This command is usually invoked as <code>@bors try @rust-timer queue</code>,
24-
which starts a bors "try" run (not a merge). <code>@rust-timer</code> will wait for the try run to finish,
23+
<code>@rust-timer queue</code>. This command is usually invoked as <code>@bors try @rust-timer
24+
queue</code>,
25+
which starts a bors "try" run (not a merge). <code>@rust-timer</code> will wait for the try run
26+
to finish,
2527
and if it succeeds will then queue a perf run.
2628
</p>
2729
<p><code>@rust-timer queue</code> has a few extra options that can be useful:</p>
2830
<ul>
29-
<li><code>include=&lt;INCLUDE&gt;</code> is a comma-separated list of benchmark prefixes. A benchmark is included in
31+
<li><code>include=&lt;INCLUDE&gt;</code> is a comma-separated list of benchmark prefixes. A
32+
benchmark is included in
3033
the run only if its name matches one of the given prefixes.
3134
</li>
32-
<li><code>exclude=&lt;EXCLUDE&gt;</code> is a comma-separated list of benchmark prefixes, and the inverse of <code>include=</code>.
33-
A benchmark is excluded from the run if its name matches one of the given prefixes.</li>
35+
<li><code>exclude=&lt;EXCLUDE&gt;</code> is a comma-separated list of benchmark prefixes, and
36+
the inverse of <code>include=</code>.
37+
A benchmark is excluded from the run if its name matches one of the given prefixes.
38+
</li>
3439
<li><code>runs=&lt;RUNS&gt;</code> configures how many times the benchmark is run. <code>&lt;RUNS&gt;</code>
35-
is an integer. All benchmarks run at least once by default, but some run more than one time. You can use
36-
the <code>runs</code> option to override the default run count and make every benchmark run for
40+
is an integer. All benchmarks run at least once by default, but some run more than one time.
41+
You can use
42+
the <code>runs</code> option to override the default run count and make every benchmark run
43+
for
3744
<code>&lt;RUNS&gt;</code> times.
3845
</li>
46+
<li><code>backends=&lt;BACKENDS&gt;</code> configures which codegen backends should be
47+
benchmarked.
48+
By default, only the LLVM backend is benchmarked. If you select a non-default codegen backend,
49+
rustc-perf will also gather data for this backend for the parent/baseline commit, so that we
50+
have something to compare to.
51+
</li>
3952
</ul>
40-
<p><code>@rust-timer build $commit</code> will queue a perf run for the given commit <code>$commit</code>.
53+
<p><code>@rust-timer build $commit</code> will queue a perf run for the given commit
54+
<code>$commit</code>.
4155
It is usually invoked with the commit from a successful "try" run. (The
4256
<code>queue</code> command can be seen as a shortcut that automatically selects the
4357
"try" run's commit for the <code>build</code> command)
44-
This command also supports the same <code>include</code>, <code>exclude</code>, and <code>runs</code> options
45-
as <code>@rust-timer queue</code>.
58+
This command also supports the same options as <code>@rust-timer queue</code>.
4659
</p>
4760
</div>
4861
{% endblock %}

0 commit comments

Comments
 (0)