about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorNiko Matsakis <niko@alum.mit.edu>2018-09-07 11:00:09 -0400
committerWho? Me?! <mark-i-m@users.noreply.github.com>2018-09-10 19:25:29 -0500
commit1bd737675aa3a8c29a8eb660bdde9e2500a6ed4e (patch)
tree460c5a3d44ec88a709e208e3a4ed0d8d3a9b0067 /src/doc/rustc-dev-guide
parent776fc2ad18e129ef6d6d7a7c8fc18d276c7c6c66 (diff)
downloadrust-1bd737675aa3a8c29a8eb660bdde9e2500a6ed4e.tar.gz
rust-1bd737675aa3a8c29a8eb660bdde9e2500a6ed4e.zip
don't write `rust-prof` bur rather `<toolchain>
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/profiling/with_perf.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/src/doc/rustc-dev-guide/src/profiling/with_perf.md b/src/doc/rustc-dev-guide/src/profiling/with_perf.md
index 740b0a2633a..683b61d2e1e 100644
--- a/src/doc/rustc-dev-guide/src/profiling/with_perf.md
+++ b/src/doc/rustc-dev-guide/src/profiling/with_perf.md
@@ -11,7 +11,7 @@ This is a guide for how to profile rustc with [perf](https://perf.wiki.kernel.or
   - `use-jemalloc = false` — lets you do memory use profiling with valgrind 
   - leave everything else the defaults
 - Run `./x.py build` to get a full build
-- Make a rustup toolchain (let's call it `rust-prof`) pointing to that result
+- Make a rustup toolchain pointing to that result
   - see [the "build and run" section for instructions](../how-to-build-and-run.html#toolchain)
   
 ## Gathering a perf profile
@@ -37,10 +37,11 @@ to get call-graph information from debuginfo, which is accurate. The
 do:
 
 ```
-perf record -F99 --call-graph dwarf cargo +rust-prof rustc
+perf record -F99 --call-graph dwarf cargo +<toolchain> rustc
 ```
 
-to run `cargo`. But there are some things to be aware of:
+to run `cargo` -- here `<toolchain>` should be the name of the toolchain
+you made in the beginning. But there are some things to be aware of:
 
 - You probably don't want to profile the time spend building
   dependencies. So something like `cargo build; cargo clean -p $C` may
@@ -77,10 +78,13 @@ build the dependencies:
 
 ```bash
 # Setup: first clean out any old results and build the dependencies:
-> cargo +rust-prof clean
-> CARGO_INCREMENTAL=0 cargo +rust-prof check
+> cargo +<toolchain> clean
+> CARGO_INCREMENTAL=0 cargo +<toolchain> check
 ```
 
+(Again, `<toolchain>` should be replaced with the name of the
+toolchain we made in the first step.)
+
 Next: we want record the execution time for *just* the clap-rs crate,
 running cargo check. I tend to use `cargo rustc` for this, since it
 also allows me to add explicit flags, which we'll do later on.