rust-lang / rust-lang/rustc-dev-guide

Add information on running the compiler with cachegrind and valgrind

Open
#1,166 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-performance C-enhancement E-medium T-compiler WG-compiler-performance
Dominant language
HTML
Stars
1.9k
Forks
613
Avg merge
17h 24m
Merged PRs (30d)
39

Description

As a follow-up to #88, we should include more specifics on tools like cachegrind and valgrind. From the original issue:

those [tools] provide a slightly different and useful set of measurements but come with some caveats when invoking the profiler (i.e. making sure that the rustc executable is profiled, not cargo or the rustup wrapper).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the profiling guidance and the context in issue #88. Document how to run cachegrind and valgrind for rustc, including the caveat that the rustc executable—not cargo or the rustup wrapper—must be profiled; the issue is done when these instructions and measurements are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.