From b08ac2ae3ecca27f324ccfc033421238c6661491 Mon Sep 17 00:00:00 2001 From: Michael Sloan Date: Mon, 11 Nov 2024 21:03:46 -0700 Subject: [PATCH] Heaptrack documentation (#20266) Release Notes: - N/A --- docs/src/development/linux.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/src/development/linux.md b/docs/src/development/linux.md index ab55782f57..5dba44d2f0 100644 --- a/docs/src/development/linux.md +++ b/docs/src/development/linux.md @@ -111,6 +111,23 @@ To build & install the Flatpak package locally follow the steps below: 3. Run `script/flatpak/bundle-flatpak`. 4. Now the package has been installed and has a bundle available at `target/release/{app-id}.flatpak`. +## Memory profiling + +[`heaptrack`](https://github.com/KDE/heaptrack) is quite useful for diagnosing memory leaks. To install it: + +```sh +$ sudo apt install heaptrack heaptrack-gui +$ cargo install cargo-heaptrack +``` + +Then, to build and run Zed with the profiler attached: + +```sh +$ cargo heaptrack -b zed +``` + +When this zed instance is exited, terminal output will include a command to run `heaptrack_interpret` to convert the `*.raw.zst` profile to a `*.zst` file which can be passed to `heaptrack_gui` for viewing. + ## Troubleshooting ### Can't compile Zed