Skip to content

Include the profile in a result's summary; more documentation for rust-timer commands #1146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 17, 2022
Merged

Include the profile in a result's summary; more documentation for rust-timer commands #1146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5abd027
add profile in benchmark result summary line
lqd Jan 13, 2022
6795044
document rust-timer commands on the help page
lqd Jan 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions site/src/comparison.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1000,8 +1000,8 @@ impl TestResultComparison {
.unwrap();
writeln!(
summary,
" (up to {:.1}% on `{}` builds of `{}`)",
percent, self.scenario, self.benchmark
" (up to {:.1}% on `{}` builds of `{} {}`)",
percent, self.scenario, self.benchmark, self.profile
)
.unwrap();
}
Expand Down
16 changes: 14 additions & 2 deletions site/static/help.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,20 @@ <h3><b><code>@rust-timer</code> commands</b></h3>
<code>&lt;RUNS&gt;</code> times.
</li>
</ul>
<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><code>@rust-timer</code> has
<a href="https://github.com/rust-lang/rustc-perf/blob/dcae222b6a7fbb4c9e21d95bc93313ebe5107c7c/site/src/request_handlers/github.rs#L12-L21">more commands</a>
than just <code>@rust-timer queue</code>, but the <code>queue</code> command is the most used.
</p>
<p><code>@rust-timer build $commit</code> will queue a perf run for the given commit <code>$commit</code>.
It is usually invoked with the commit from a successful "try" run. (The
<code>queue</code> command can be seen as a shortcut that automatically selects the
"try" run's commit for the <code>build</code> command)
This command also supports the same <code>include</code>, <code>exclude</code>, and <code>runs</code> options
as <code>@rust-timer queue</code>.
</p>
<p>
The other two commands are a work in progress and will be documented here when they're
finalized. They are dedicated to helping diagnose the cause of regressions in rollup PRs.
</p>
<script src="shared.js"></script>
</body>
Expand Down