Skip to content

Commit 0c00c74

Browse files
committed
Assorted minor documentation improvements.
1 parent 423f578 commit 0c00c74

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

collector/benchmarks/README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,8 @@ compiler in interesting ways.
9898
actix-web and other libraries with similarly nested type combinators.
9999
- **regression-31157**: A small program that caused a [large performance
100100
regression](https://github.com/rust-lang/rust/issues/31157) from the past.
101-
- **token-stream-stress**: Constructs a long token stream much like the `quote`
102-
crate does, which caused [quadratic
101+
- **token-stream-stress**: A proc-macro crate. Constructs a long token stream
102+
much like the `quote` crate does, which caused [quadratic
103103
behavior](https://github.com/rust-lang/rust/issues/65080) in the past.
104104
- **tt-muncher**: Calls a quadratic TT muncher macro (based on `quote::quote!`)
105105
with a long input, which stresses macro expansion.
@@ -190,13 +190,8 @@ Rust code being written today.
190190
applies correctly, e.g. `target/release/collector bench_local +nightly
191191
--id Test --profiles=Check --scenarios=IncrPatched
192192
--include=$NEW_BENCHMARK`
193-
- `git grep` for occurrences of the old benchmark name (e.g. in
194-
`.github/workflows/ci.yml` or `ci/check-*.sh`) and see if anything similar
195-
needs doing for the new benchmark... usually not.
196-
- Add the new entry to `collector/benchmarks/README.md`. Don't remove the
197-
entry for the old benchmark yet.
198-
- Compare benchmarking time for the old and new versions of the benchmark.
199-
(It's useful to know if the new one is a lot slower than the old one.)
193+
- Add the new entry to `collector/benchmarks/README.md`.
194+
- Consider the benchmarking time for the benchmark.
200195
- First, measure the entire compilation time with something like this, by
201196
doing this within the benchmark directory is good:
202197
```
@@ -232,9 +227,13 @@ Rust code being written today.
232227
233228
## Update a benchmark
234229
235-
- Do this in two steps. First add the new version of the benchmark. Once the PR
236-
is merged, make sure it's running correctly. Second, remove the old version
237-
of the benchmark. Doing it in two steps ensures we have continuity of
238-
profiling coverage in the case where something goes wrong.
230+
- Do this in two steps.
231+
- First add the new version of the benchmark. Compare the benchmarking time
232+
of the two versions to make sure nothing outrageous has happened. Once the
233+
PR is merged, make sure it's running correctly.
234+
- Second, remove the old version of the benchmark.
235+
Doing it in two steps ensures we have continuity of profiling coverage in the
236+
case where something goes wrong.
237+
- Compare the benchmarking time of the two versions.
239238
- When adding the new version, for `perf-config.json` and the `N-*.patch`
240239
files, use the corresponding files for the old version as a starting point.

0 commit comments

Comments
 (0)