Add instructions for how to do debug builds

2026-07-07 17:43:53 +02:00 · 2022-04-09 08:07:29 +05:30
parent b78fbb4521
commit 601b2a05ac
1 changed files with 13 additions and 0 deletions
--- a/docs/build.rst
+++ b/docs/build.rst
@@ -125,6 +125,19 @@ make them available in the newly spawned shell.
 Then proceed with ``make`` or ``make app`` according to the platform specific instructions above.


+Debug builds
+--------------
+
+A basic debug build can be done with::
+
+    make debug
+
+This includes debug info in the binary for better traces. To build with address sanitizer, use::
+
+    make asan
+
+Which will result in a debug binary that uses the address sanitizer as well.
+
 .. _packagers:

 Notes for Linux/macOS packagers