Skip to content

Commit 1a593d0

Browse files
authored
Merge pull request #55 from wesleywiser/readme
Improve the readme
2 parents 997e08d + 8771169 commit 1a593d0

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,34 @@ This crate is maintained by the Rust compiler team and in particular by the
55
[self-profile working group][wg-self-profile]. It is currently only meant to
66
be used within rustc itself, so APIs may change at any moment.
77

8+
## Tools
9+
10+
### measureme
11+
12+
`measureme` is the core library which contains a fast, efficient framework for recording events and serializing them to a compact binary format. It is integrated into `rustc` via the unstable `-Z self-profile` flag.
13+
14+
[Documentation](https://docs.rs/measureme)
15+
16+
### summarize
17+
18+
`summarize` produces a human readable summary of `measureme` profilng data.
19+
It contains two main modes:
20+
21+
- `summarize` which groups the profiling events and orders the results by time taken.
22+
- `diff` which compares two profiles and outputs a summary of the differences.
23+
24+
[Learn more](./summarize/Readme.md)
25+
26+
### stack_collapse
27+
28+
`stack_collapse` reads `measureme` profiling data and outputs folded stack traces compatible with the [Flame Graph](https://github.com/brendangregg/FlameGraph) tools.
29+
30+
[Learn more](./stack_collapse/README.md)
31+
32+
### crox
33+
34+
`crox` turns `measureme` profiling data into files that can be visualized by the Chromium performance tools.
35+
36+
[Learn more](./crox/Readme.md)
37+
838
[wg-self-profile]: https://rust-lang.github.io/compiler-team/working-groups/self-profile/

0 commit comments

Comments
 (0)