Add heaptrack memory profiling docs - #3001
Open
laundmo wants to merge 4 commits into
Open
Conversation
Collaborator
|
Thanks for the PR. If you have write access, feel free to merge this PR if it does not need reviews. You can request a review using |
rustbot
added
the
S-waiting-on-review
Comment on lines
+4
to
+12
| with [heaptrack](https://invent.kde.org/sdk/heaptrack) on linux. | ||
|
|
||
| ## Installing heaptrack | ||
|
|
||
| While heaptrack has support for demangling rust symbols, | ||
| the last full release is older than this support. | ||
|
|
||
| That means either you have to compile heaptrack from | ||
| its [git repo](https://invent.kde.org/sdk/heaptrack/), |
Member
There was a problem hiding this comment.
Since the two links overlap, it might be better to change it so that one references the other.
with [heaptrack][heaptrack repo] on linux.
...
its [git repo][heaptrack repo],
...
[heaptrack repo]: https://invent.kde.org/sdk/heaptrack/
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
While working on rust-lang/rust#162031 i've been primarily using Heaptrack.
Alas, its not as easy as just running cargo with it. First, its nice to have rust symbol demangling which needs some work, and then it needs a RUSTC_WRAPPER script because it doesn't work on child processes.
Since thats a bit of a hassle, i thought documenting it would be nice.