Fix repo docs (#63486)

* ensures The Rule cannot be accidentall removed
* fixes the perf command example to capture call graphs, to avoid
round-trips like
https://github.com/zed-industries/zed/issues/59689#issuecomment-5453623044
(samples without call graphs are not quite usable for investigating bugs
like these)


Release Notes:

- N/A
This commit is contained in:
Kirill Bulatov authored and GitHub committed 2026-08-31 11:00:40 +00:00
1 parent bce0c5785b
commit 6840b8d2fc
2 files changed
+32 -4

No files matched your search

+2 -1
View File
@@ -128,7 +128,8 @@ Use this when Zed is using a lot of CPU. It is not useful for hangs.
On Ubuntu (derivatives) run `sudo apt install linux-tools`.
- Perf record:
Run `sudo perf record -p <pid you just found>`, wait a few seconds to gather data, then press Ctrl+C. You should now have a `perf.data` file.
Run `sudo perf record -g --call-graph dwarf -p <pid you just found>`, wait a few seconds to gather data, then press Ctrl+C. You should now have a `perf.data` file.
The `--call-graph dwarf` part records the callers of every sampled function: without it, the profile shows isolated hot symbols with no way to tell who invoked them, which is rarely enough to act on.
- Make the output file user owned:
run `sudo chown $USER:$USER perf.data`