Skip to content

Commit 10bf13b

Browse files
Merge pull request #846 from camelid/help-page
Add basic help page to document rust-timer commands
2 parents 96b7bdf + 677a309 commit 10bf13b

File tree

7 files changed

+48
-6
lines changed

7 files changed

+48
-6
lines changed

site/static/bootstrap.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
<body>
5555
<div>&gt; <a href="index.html">graphs</a>, <a href="compare.html">compare</a>,
5656
<a href="dashboard.html">dashboard</a>, <a href="bootstrap.html">bootstrap</a>,
57-
<a href="status.html">status</a>.</div>
57+
<a href="status.html">status</a>, <a href="help.html">help</a>.</div>
5858
<div id="settings">
5959
start: <input placeholder="yyyy-mm-dd or commit" id="start-bound" />
6060
end: <input placeholder="yyyy-mm-dd or commit" id="end-bound" />

site/static/compare.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<body class="container" style="max-width:800px">
2323
<div>&gt; <a href="index.html">graphs</a>, <a href="compare.html">compare</a>,
2424
<a href="dashboard.html">dashboard</a>, <a href="bootstrap.html">bootstrap</a>,
25-
<a href="status.html">status</a>.</div>
25+
<a href="status.html">status</a>, <a href="help.html">help</a>.</div>
2626
<div style=''>
2727
<p>Warning: although measurements known to have high variation are marked with
2828
'?'/'??', this does not mean that unmarked measurements are guaranteed to have

site/static/dashboard.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<body class="container">
1212
<div>&gt; <a href="index.html">graphs</a>, <a href="compare.html">compare</a>,
1313
<a href="dashboard.html">dashboard</a>, <a href="bootstrap.html">bootstrap</a>,
14-
<a href="status.html">status</a>.</div>
14+
<a href="status.html">status</a>, <a href="help.html">help</a>.</div>
1515
<div id="check-average-times"></div>
1616
<div id="debug-average-times"></div>
1717
<div id="opt-average-times"></div>

site/static/detailed-query.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
<body class="container">
5353
<div>&gt; <a href="index.html">graphs</a>, <a href="compare.html">compare</a>,
5454
<a href="dashboard.html">dashboard</a>, <a href="bootstrap.html">bootstrap</a>,
55-
<a href="status.html">status</a>.</div>
55+
<a href="status.html">status</a>, <a href="help.html">help</a>.</div>
5656
<div id="content">
5757
<h3 id="title"></h3>
5858
<div id="raw-urls"></div>

site/static/help.html

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title>rustc performance data</title>
6+
<link rel="stylesheet" type="text/css" href="perf.css">
7+
<link rel="alternate icon" type="image/png" href="/favicon-32x32.png">
8+
<link rel="icon" type="image/svg+xml" href="/favicon.svg">
9+
<style>
10+
.help-content {
11+
font-family: Helvetica, Arial, sans-serif;
12+
line-height: 140%;
13+
font-size: 16px;
14+
max-width: 50em;
15+
}
16+
.help-content code {
17+
background: #eee;
18+
border-radius: 5px;
19+
padding: 2px;
20+
}
21+
</style>
22+
</head>
23+
<body class="container">
24+
<div>&gt; <a href="index.html">graphs</a>, <a href="compare.html">compare</a>,
25+
<a href="dashboard.html">dashboard</a>, <a href="bootstrap.html">bootstrap</a>,
26+
<a href="status.html">status</a>, <a href="help.html">help</a>.</div>
27+
<div style="text-align: center;">
28+
<a href="https://github.com/rust-lang-nursery/rustc-perf">Contribute on GitHub</a>
29+
</div>
30+
<div class="help-content">
31+
<h3><b><code>@rust-timer</code> commands</b></h3>
32+
<p><code>@rust-timer</code> supports several commands, the most common (and simple) being <code>@rust-timer queue</code>. This command is usually invoked as <code>@bors try @rust-timer queue</code>, which starts a bors "try" run (not a merge). <code>@rust-timer</code> will wait for the try run to finish, and if it succeeds will then queue a perf run.</p>
33+
<p><code>@rust-timer queue</code> has a few extra options that can be useful:</p>
34+
<ul>
35+
<li><code>include=&lt;INCLUDE&gt;</code> only runs benchmarks with <code>&lt;INCLUDE&gt;</code> in their title. For example, if you just want to run rustdoc benchmarks, do <code>@bors try @rust-timer queue include=-doc</code>; the <code>-doc</code> matches the <code>-doc</code> appended to rustdoc benchmarks. <code>&lt;INCLUDE&gt;</code> is a comma-separated list of substrings; only one of the items in the list of substrings must match.</li>
36+
<li><code>exclude=&lt;EXCLUDE&gt;</code> is similar to <code>include=</code>, but instead skips any benchmarks that have one of the items in the list of substrings as a substring of its name.</li>
37+
<li><code>runs=&lt;RUNS&gt;</code> configures how many times the benchmark is run. <code>&lt;RUNS&gt;</code> is an integer. All benchmarks run at least once by default, but some run more than one time. You can use the <code>runs</code> option to override the default run count and make every benchmark run for <code>&lt;RUNS&gt;</code> times.</li>
38+
</ul>
39+
<p><code>@rust-timer</code> has more commands than just <code>@rust-timer queue</code>, but the <code>queue</code> command is the most used.</p>
40+
<script src="shared.js"></script>
41+
</body>
42+
</html>

site/static/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
<body>
5555
<div>&gt; <a href="index.html">graphs</a>, <a href="compare.html">compare</a>,
5656
<a href="dashboard.html">dashboard</a>, <a href="bootstrap.html">bootstrap</a>,
57-
<a href="status.html">status</a>.</div>
57+
<a href="status.html">status</a>, <a href="help.html">help</a>.</div>
5858
<div id="settings">
5959
start: <input placeholder="yyyy-mm-dd or commit" id="start-bound" />
6060
end: <input placeholder="yyyy-mm-dd or commit" id="end-bound" />

site/static/status.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<body class="container">
2121
<div>&gt; <a href="index.html">graphs</a>, <a href="compare.html">compare</a>,
2222
<a href="dashboard.html">dashboard</a>, <a href="bootstrap.html">bootstrap</a>,
23-
<a href="status.html">status</a>.</div>
23+
<a href="status.html">status</a>, <a href="help.html">help</a>.</div>
2424
<div id="data">
2525
<div id="data-insert-js"></div>
2626
Benchmarks for last commit:

0 commit comments

Comments
 (0)