rust-lang / rust-lang/rustc-dev-guide
Add section about self-profiling and measureme
Open
Nobody has claimed this yet.
A-performance
E-medium
E-needs-info
E-needs-investigation
T-compiler
WG-compiler-performance
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
The in-tree documentation about this is not too bad but it would be good to give a high-level overview here, and especially add a step-by-step guide how to add new measurements (what needs to land in measureme and what in the compiler and how to sequence that).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the existing in-tree documentation on self-profiling and measurements. Document a high-level overview and a step-by-step guide covering what lands in measureme versus the compiler and how to sequence the work; done means both topics are clearly explained.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100