Skip to content

Commit 7e4b5d7

Browse files
Fix commit according to PR review
Changed so cargo specifies the binary collector, removing the need to link to its local binary. Clarified that the SHAs should be from the rustc-repo, but the command should be ran in the rustc-perf repo.
1 parent 4e4abbb commit 7e4b5d7

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

src/profiling/with_rustc_perf.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,16 @@ To start, in the `rustc-perf` repo, build the collector, which runs the Rust com
3434
```
3535
cargo build --release -p collector
3636
```
37-
After this the collector can be located in `.\target\release\collector`, can be run locally with `bench_local` and expects the following arguments:
37+
The collector can then be run using cargo, specifying the collector binary. It expects the following arguments:
3838
- `<PROFILE>`: Profiler selection for how performance should be measured. For this example we will use Cachegrind.
3939
- `<RUSTC>`: The Rust compiler revision to benchmark, specified as a commit SHA from `rust-lang/rust`.
40-
Optional arguments allow running profiles and scenarios as described above. `--include` in `x perf` is instead `--exact-match`. More information regarding the mandatory and
40+
Optional arguments allow running profiles and scenarios as described above. More information regarding the mandatory and
4141
optional arguments can be found in the [rustc-perf-readme-profilers].
4242

43-
Then, for the case of generating a profile diff for the crate `serve_derive-1.0.136`, for two commits `<SHA1>` and `<SHA2>` in the `rust-lang/rust` repository, run the following
43+
Then, for the case of generating a profile diff for the crate `serve_derive-1.0.136`, for two commits `<SHA1>` and `<SHA2>` from the `rust-lang/rust` repository,
44+
run the following in the `rustc-perf` repo:
4445
```
45-
./target/release/collector profile_local cachegrind +<SHA1> --rustc2 +<SHA2> --exact-match serde_derive-1.0.136 --profiles Check --scenarios IncrUnchanged
46+
cargo run --release --bin collector profile_local cachegrind +<SHA1> --rustc2 +<SHA2> --exact-match serde_derive-1.0.136 --profiles Check --scenarios IncrUnchanged
4647
```
4748

4849

0 commit comments

Comments
 (0)