From 601b2a05ac7580233f5807845219b923a31fd17d Mon Sep 17 00:00:00 2001
From: Kovid Goyal <kovid@kovidgoyal.net>
Date: Sat, 9 Apr 2022 08:07:29 +0530
Subject: [PATCH] Add instructions for how to do debug builds

---
 docs/build.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/build.rst b/docs/build.rst
index 1d080af0e..512d66728 100644
--- 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