Skip to content

Commit 3d13993

Browse files
committed
Update glossary and schema
1 parent e53cc5b commit 3d13993

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

database/schema.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ aid date_recorded duration
104104

105105
The different types of compile-time benchmarks that are run.
106106

107-
The table stores the name of the benchmark as well as whether it is capable of being run using the stable compiler and what is its category.
108-
The benchmark name is used as a foreign key in many of the other tables.
107+
The table stores the name of the benchmark, whether it is capable of being run using the stable compiler,
108+
and its category. The benchmark name is used as a foreign key in many of the other tables.
109109

110110
Category is either `primary` (real-world benchmark) or `secondary` (stress test).
111111
Stable benchmarks have `category` set to `primary` and `stabilized` set to `1`.

docs/glossary.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,21 @@ The following is a glossary of domain specific terminology. Although benchmarks
66

77
* **metric**: a name of a quantifiable metric being measured (e.g., instruction count).
88
* **artifact**: a specific rustc binary labeled by some identifier tag (usually a commit sha or some sort of human readable id like "1.51.0" or "test").
9+
* **benchmark suite**: an entire collection of benchmarks, either compile-time or runtime.
910

1011
## Compile-time benchmark terms
1112

1213
* **benchmark**: the source of a crate which will be used to benchmark rustc. For example, ["hello world"](https://github.com/rust-lang/rustc-perf/tree/master/collector/compile-benchmarks/helloworld).
13-
* **profile**: a [cargo profile](https://doc.rust-lang.org/cargo/reference/profiles.html). Note: the database uses "opt" whereas cargo uses "release".
14-
* **scenario**: The scenario under which a user is compiling their code. Currently, this is the incremental cache state and an optional change in the source since last compilation (e.g., full incremental cache and a `println!` statement is added).
14+
* **profile**: a compilation configuration.
15+
- `check` corresponds to running `cargo check`.
16+
- `debug` corresponds to running `cargo build`.
17+
- `opt` corresponds to running `cargo build --release`.
18+
- `doc` corresponds to running rustdoc.
19+
* **scenario**: describes the incremental cache state and an optional change in the source since last compilation.
20+
- `full`: incremental compilation is not used.
21+
- `incr-full`: incremental compilation is used, with an empty incremental cache.
22+
- `incr-unchanged`: incremental compilation is used, with a full incremental cache and no code changes made.
23+
- `incr-patched`: incremental compilation is used, with a full incremental cache and some code changes made.
1524
* **category**: a high-level group of benchmarks. Currently, there are three categories, primary (mostly real-world crates), secondary (mostly stress tests), and stable (old real-world crates, only used for the dashboard).
1625

1726
### Types of compile-time benchmarks

0 commit comments

Comments
 (0)