Add basic documentation for debug-paths and extra-paths

KDE · Jul 12, 2024 · 9c18231 · 9c18231
1 parent db9f129
commit 9c18231
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -62,6 +62,14 @@ Then, you can analyze it:
 
     heaptrack --analyze "/tmp/heaptrack.test_c.8911.zst"
 
+If you have other folders outside of the sysroot that contain debug information, you can pass them via `--debug-paths`
+to `heaptrack --interpret`, see also: https://sourceware.org/gdb/current/onlinedocs/gdb.html/Separate-Debug-Files.html
+
+Furthermore, if you have custom code side loaded and want to load the debug information from the respective build
+folders, use `--extra-paths`, e.g.:
+
+    heaptrack --interpret "/path/heaptrack.test_c.8911.raw.zst" --sysroot "/path/to/sysroot"
+
 ## Building heaptrack
 
 Heaptrack is split into two parts: The data collector, i.e. `heaptrack` itself, and the

diff --git a/tests/auto/test_sysroot/README.md b/tests/auto/test_sysroot/README.md
@@ -3,10 +3,10 @@ The files in here are used for the sysroot-resolve auto test
 - libtestlib.so is copied over directly to the path from my system
   this allows us to test resolving via `--sysroot`
 - test_lib is put into another folder
-  this allows us to test the `--extraLibPaths` feature
+  this allows us to test the `--extra-paths` feature
 - then the debug info for a system lib referenced by the
   executable is copied to various places to test that finding
-  them with the default path as well as the `--debugPaths` feature.
+  them with the default path as well as the `--debug-paths` feature.
   These files get the `.debug` suffix too.
 
 All files are stripped for safety purposes and since we don't