@@ -116,9 +116,9 @@ The following options alter the behaviour of the `bench_local` subcommand.
116
116
with ` --builds ` ). If a ` Doc ` build is requested, by default the tool will
117
117
look for a rustdoc executable next to the rustc specified via the ` <RUSTC> `
118
118
argument.
119
- - ` --self-profile ` : enable self-profiling, i.e. the inclusion of query
120
- statistics in the output. The ` measureme ` tool must be installed for this to
121
- work.
119
+ - ` --self-profile ` : use rustc's ` -Zself-profile ` option to produce
120
+ query/function tables in the output. The ` measureme ` tool must be installed
121
+ for this to work.
122
122
123
123
` RUST_LOG=debug ` can be specified to enable verbose logging, which is useful
124
124
for debugging ` collector ` itself.
@@ -199,19 +199,19 @@ It will profile the entire suite and put the results in a directory called
199
199
200
200
The mandatory ` <PROFILER> ` argument must be one of the following.
201
201
- ` self-profile ` : Profile with rustc's ` -Zself-profile ` .
202
- - ** Purpose** . This gives multiple high-level views of compiler performance,
203
- in both tabular and graphical form. It is related to, but distinct from,
204
- the profiling done by the ` --self-profiling ` option of the ` bench_local `
205
- subcommand.
202
+ - ** Purpose** . This gathers the same high-level query/function data as the
203
+ ` --self-profile ` option of the ` bench_local ` subcommand, but it presents
204
+ the data in three different forms.
206
205
- ** Slowdown** . Minimal.
207
206
- ** Output** . Raw output is written to a directory with a ` Zsp ` prefix.
208
207
The files in that directory can be processed with various
209
208
[ ` measureme ` ] ( https://github.com/rust-lang/measureme/ ) tools.
210
209
Human-readable output from ` summarize ` is written to a file with a
211
- ` summarize ` prefix. Output from ` flamegraph ` , viewable with a web browser,
212
- is written to a file with a ` flamegraph ` prefix. Output from ` crox ` ,
213
- viewable with Chromium's profiler, is written to a file with a ` crox `
214
- prefix.
210
+ ` summarize ` prefix; this is very similar to the query/function tables
211
+ produced by ` bench_local ` with the ` --self-profile ` option. Output from
212
+ ` flamegraph ` , viewable with a web browser, is written to a file with a
213
+ ` flamegraph ` prefix. Output from ` crox ` , viewable with Chromium's profiler,
214
+ is written to a file with a ` crox ` prefix.
215
215
- ` time-passes ` : Profile with rustc's ` -Ztime-passes ` .
216
216
- ** Purpose** . This gives a high-level indication of compiler performance by
217
217
showing how long each compilation pass takes.
0 commit comments