Skip to content

Commit 6795044

Browse files
committed
document rust-timer commands on the help page
1 parent 5abd027 commit 6795044

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

site/static/help.html

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,20 @@ <h3><b><code>@rust-timer</code> commands</b></h3>
5454
<code>&lt;RUNS&gt;</code> times.
5555
</li>
5656
</ul>
57-
<p><code>@rust-timer</code> has more commands than just <code>@rust-timer queue</code>, but the
58-
<code>queue</code> command is the most used.
57+
<p><code>@rust-timer</code> has
58+
<a href="https://github.com/rust-lang/rustc-perf/blob/dcae222b6a7fbb4c9e21d95bc93313ebe5107c7c/site/src/request_handlers/github.rs#L12-L21">more commands</a>
59+
than just <code>@rust-timer queue</code>, but the <code>queue</code> command is the most used.
60+
</p>
61+
<p><code>@rust-timer build $commit</code> will queue a perf run for the given commit <code>$commit</code>.
62+
It is usually invoked with the commit from a successful "try" run. (The
63+
<code>queue</code> command can be seen as a shortcut that automatically selects the
64+
"try" run's commit for the <code>build</code> command)
65+
This command also supports the same <code>include</code>, <code>exclude</code>, and <code>runs</code> options
66+
as <code>@rust-timer queue</code>.
67+
</p>
68+
<p>
69+
The other two commands are a work in progress and will be documented here when they're
70+
finalized. They are dedicated to helping diagnose the cause of regressions in rollup PRs.
5971
</p>
6072
<script src="shared.js"></script>
6173
</body>

0 commit comments

Comments
 (0)