summaryrefslogtreecommitdiff
path: root/doc/en/weechat_user.en.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/en/weechat_user.en.adoc')
-rw-r--r--doc/en/weechat_user.en.adoc11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc
index e06a27a59..98d9d5fcf 100644
--- a/doc/en/weechat_user.en.adoc
+++ b/doc/en/weechat_user.en.adoc
@@ -390,6 +390,9 @@ If you're compiling with CMake:
$ cmake .. -DCMAKE_BUILD_TYPE=Debug
----
+[[build_debug_address_sanitizer]]
+==== Build with debug options and address sanitizer
+
You can additionally enable the address sanitizer, which causes WeeChat to
crash immediately in case of problem:
@@ -401,7 +404,13 @@ $ cmake .. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_FLAGS=-fsanitize=address -DCMAKE_C
You should enable address sanitizer only if you're trying to cause a crash,
this is not recommended in production.
-If you installed a binary package, then install package _weechat-dbg_.
+Then once compiled and installed, you must run WeeChat like this:
+
+----
+$ ASAN_OPTIONS="detect_odr_violation=0 log_path=asan.log" weechat
+----
+
+In case of crash, the backtrace is in file `asan.log`.
[[core_files]]
==== Core files