Skip to content

Commit 8e791d0

Browse files
committed
Update documentation
1 parent b51c7b7 commit 8e791d0

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

collector/compile-benchmarks/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,9 @@ Rust code being written today.
173173
anything we should be aware of when using this crate as a compile-time
174174
benchmark.
175175
- Look at [crates.io](https://crates.io) to find the latest (non-prerelease) version.
176-
- Download it with `collector download -c $CATEGORY crate $NAME $VERSION`.
177-
The `$CATEGORY` is probably `primary`.
176+
- Download it with `collector download -c $CATEGORY -a $ARTIFACT crate $NAME $VERSION`.
177+
The `$CATEGORY` is probably `primary`. `$ARTIFACT` is either `library` or `binary`, depending
178+
on what kind of artifact does the benchmark build.
178179
- It makes it easier for reviewers if you split things into two commits.
179180
- In the first commit, just add the code for the entire benchmark.
180181
- Do this by doing `git add` on the new directory.

docs/glossary.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ The following is a glossary of domain specific terminology. Although benchmarks
2222
- `incr-unchanged`: incremental compilation is used, with a full incremental cache and no code changes made.
2323
- `incr-patched`: incremental compilation is used, with a full incremental cache and some code changes made.
2424
* **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).
25+
* **artifact type**: describes what kind of artifact does the benchmark build. Either `library` or `binary`.
2526

2627
### Types of compile-time benchmarks
2728

0 commit comments

Comments
 (0)