doc: add instructions to build WeeChat with address sanitizer (user's guide)

diff --git a/doc/de/weechat_user.de.adoc b/doc/de/weechat_user.de.adoc
index 371aba629e39a5110f1e81a44310c3961cc9b525..e970ba768315b761476ea1e8a388568770de5937 100644 (file)
--- a/doc/de/weechat_user.de.adoc
+++ b/doc/de/weechat_user.de.adoc
@@ -382,12 +382,17 @@ Folgen Sie bitte der Anleitung zur Erstellung aus Quellpaketen (siehe <<source_p
 
 Falls WeeChat abgestürzt sein sollte und Sie diesen Fehler melden möchten:
 
-* kompilieren Sie WeeChat mit Debug-Information (oder installieren Sie das Binärpaket mit Debug-Information)
+// TRANSLATION MISSING
+* Compile with:
+** Debug-Information (oder installieren Sie das Binärpaket mit Debug-Information)
+// TRANSLATION MISSING
+** compile it with address sanitizer (optional)
 * aktivieren Sie _core_ Dateien auf Ihrem System
 * installieren Sie gdb
 
-[[debug_info]]
-==== Debug info
+// TRANSLATION MISSING
+[[build_debug]]
+==== Build with debug options
 
 Bei der Kompilierung mit CMake muss folgende Option gesetzt werden:
 
@@ -395,6 +400,19 @@ Bei der Kompilierung mit CMake muss folgende Option gesetzt werden:
 $ cmake .. -DCMAKE_BUILD_TYPE=Debug
 ----
 
+// TRANSLATION MISSING
+You can additionally enable the address sanitizer, which causes WeeChat to
+crash immediately in case of problem:
+
+----
+$ cmake .. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_FLAGS=-fsanitize=address -DCMAKE_CXX_FLAGS=-fsanitize=address -DCMAKE_EXE_LINKER_FLAGS=-fsanitize=address
+----
+
+// TRANSLATION MISSING
+[WARNING]
+You should enable address sanitizer only if you're trying to cause a crash,
+this is not recommended in production.
+
 Wird ein Binärpaket genutzt dann muss zusätzlich das Paket _weechat-dbg_ installiert werden.
 
 [[core_files]]

diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc
index 0c5f908ceceb4d31aba33600c76496d1aeb44058..5e70968e927274fba5b4d58620a7438754c587b7 100644 (file)
--- a/doc/en/weechat_user.en.adoc
+++ b/doc/en/weechat_user.en.adoc
@@ -375,12 +375,14 @@ Then follow instructions for source package (see
 If you experienced crashes, or if you want to report any future WeeChat crash,
 you have to:
 
-* Compile it with debug info (or install binary package with debug info).
+* Compile with:
+** debug info (or install binary package with debug info),
+** address sanitizer (optional).
 * Enable _core_ files on your system.
 * Install gdb.
 
-[[debug_info]]
-==== Debug info
+[[build_debug]]
+==== Build with debug options
 
 If you're compiling with CMake:
 
@@ -388,6 +390,17 @@ If you're compiling with CMake:
 $ cmake .. -DCMAKE_BUILD_TYPE=Debug
 ----
 
+You can additionally enable the address sanitizer, which causes WeeChat to
+crash immediately in case of problem:
+
+----
+$ cmake .. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_FLAGS=-fsanitize=address -DCMAKE_CXX_FLAGS=-fsanitize=address -DCMAKE_EXE_LINKER_FLAGS=-fsanitize=address
+----
+
+[WARNING]
+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_.
 
 [[core_files]]

diff --git a/doc/fr/weechat_user.fr.adoc b/doc/fr/weechat_user.fr.adoc
index 0bcc3f5e8dc4c99135f9f714ac472ad0b20d3bab..340482260050cbaf9a97f425cf4bc0fa5b4993a6 100644 (file)
--- a/doc/fr/weechat_user.fr.adoc
+++ b/doc/fr/weechat_user.fr.adoc
@@ -386,13 +386,14 @@ Suivez alors les instructions du paquet source (voir
 Si vous avez eu des plantages, ou si vous souhaitez rapporter tout plantage
 futur de WeeChat, vous devez :
 
-* Compiler avec les infos de debug (ou installer un paquet binaire avec les
-  infos de debug).
+* Compiler avec :
+** les infos de debug (ou installer un paquet binaire avec les infos de debug),
+** la vérification des adresses (« address sanitizer ») (facultatif).
 * Activer les fichiers _core_ sur votre système.
 * Installer gdb.
 
-[[debug_info]]
-==== Infos de debug
+[[build_debug]]
+==== Construction avec options de debug
 
 Si vous compilez avec CMake :
 
@@ -400,6 +401,17 @@ Si vous compilez avec CMake :
 $ cmake .. -DCMAKE_BUILD_TYPE=Debug
 ----
 
+Vous pouvez aussi activer la vérification des adresses (« address sanitizer »),
+ce qui provoquera immédiatement un plantage de WeeChat en cas de problème :
+
+----
+$ cmake .. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_FLAGS=-fsanitize=address -DCMAKE_CXX_FLAGS=-fsanitize=address -DCMAKE_EXE_LINKER_FLAGS=-fsanitize=address
+----
+
+[WARNING]
+Vous ne devriez activer la vérification des adresses que si vous essayez de
+provoquer un plantage, ceci n'est pas recommandé en production.
+
 Si vous avez installé un paquet binaire, alors installez le paquet
 _weechat-dbg_.
 

diff --git a/doc/it/weechat_user.it.adoc b/doc/it/weechat_user.it.adoc
index 1d8ae775b545d6f296931f243ad6e858e800cbb4..666b86db70b5f3e8e6300ae13ea1fca8b33a56d8 100644 (file)
--- a/doc/it/weechat_user.it.adoc
+++ b/doc/it/weechat_user.it.adoc
@@ -416,13 +416,17 @@ Poi seguire le istruzioni per i sorgenti (consultare
 Nel caso in cui si verifichino errori, o si desideri segnalare qualsiasi errore
 futuro di WeeChat, è necessario:
 
-* compilarlo con informazioni di debug (o installare il pacchetto binario con
-  le informazioni di debug)
+// TRANSLATION MISSING
+* compile with:
+** informazioni di debug (o installare il pacchetto binario con le informazioni di debug)
+// TRANSLATION MISSING
+** address sanitizer (optional)
 * abilitare i file _core_ sul proprio sistema
 * installare gdb
 
-[[debug_info]]
-==== Informazioni di debug
+// TRANSLATION MISSING
+[[build_debug]]
+==== Build with debug options
 
 Se si compila con CMake:
 
@@ -430,6 +434,19 @@ Se si compila con CMake:
 $ cmake .. -DCMAKE_BUILD_TYPE=Debug
 ----
 
+// TRANSLATION MISSING
+You can additionally enable the address sanitizer, which causes WeeChat to
+crash immediately in case of problem:
+
+----
+$ cmake .. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_FLAGS=-fsanitize=address -DCMAKE_CXX_FLAGS=-fsanitize=address -DCMAKE_EXE_LINKER_FLAGS=-fsanitize=address
+----
+
+// TRANSLATION MISSING
+[WARNING]
+You should enable address sanitizer only if you're trying to cause a crash,
+this is not recommended in production.
+
 Se è stato installato il pacchetto binario, installare il pacchetto _weechat-gdb_.
 
 [[core_files]]

diff --git a/doc/ja/weechat_user.ja.adoc b/doc/ja/weechat_user.ja.adoc
index 60b705cdef9fc1a1aa7bd641b700d1dd838dbd04..52b442e9113fbcecd473ac3701e9701dcccf7ff4 100644 (file)
--- a/doc/ja/weechat_user.ja.adoc
+++ b/doc/ja/weechat_user.ja.adoc
@@ -383,12 +383,16 @@ $ git clone https://github.com/weechat/weechat.git
 WeeChat がクラッシュした場合、または WeeChat
 をクラッシュさせる操作を報告する場合、以下の手順に従ってください:
 
-* デバッグを有効化してコンパイル (またはデバック情報を含んだバイナリパッケージをインストール)
+// TRANSLATION MISSING
+* Compile with:
+** debug info (or install binary package with debug info),
+** address sanitizer (optional).
 * システムの _core_ ファイルを有効化
 * gdb のインストール
 
-[[debug_info]]
-==== デバッグ情報
+// TRANSLATION MISSING
+[[build_debug]]
+==== Build with debug options
 
 CMake でコンパイルする場合:
 
@@ -396,6 +400,19 @@ CMake でコンパイルする場合:
 $ cmake .. -DCMAKE_BUILD_TYPE=Debug
 ----
 
+// TRANSLATION MISSING
+You can additionally enable the address sanitizer, which causes WeeChat to
+crash immediately in case of problem:
+
+----
+$ cmake .. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_FLAGS=-fsanitize=address -DCMAKE_CXX_FLAGS=-fsanitize=address -DCMAKE_EXE_LINKER_FLAGS=-fsanitize=address
+----
+
+// TRANSLATION MISSING
+[WARNING]
+You should enable address sanitizer only if you're trying to cause a crash,
+this is not recommended in production.
+
 バイナリパッケージをインストールする場合は、_weechat-dbg_ パッケージをインストールしてください。
 
 [[core_files]]

diff --git a/doc/pl/weechat_user.pl.adoc b/doc/pl/weechat_user.pl.adoc
index 6aa1f355a1d7ca2b2f3981ef29ef83348ddafd1b..9ecc865bfaed11003fc01ac59f48be189f54070f 100644 (file)
--- a/doc/pl/weechat_user.pl.adoc
+++ b/doc/pl/weechat_user.pl.adoc
@@ -382,13 +382,16 @@ Następnie postępuj zgodnie z instrukcjami dla pakietów źródłowych (zobacz
 
 Jeśli doświadczyłeś awarii, lub chcesz zgłosić przyszłą awarię WeeChat, należy:
 
-* skompilować WeeChat z informacjami diagnostycznymi (lub zainstalować
-  odpowiedni pakiet)
+// TRANSLATION MISSING
+* compile with:
+** debug info (or install binary package with debug info)
+** address sanitizer (optional)
 * włączyć obsługę plików _core_ w systemie
 * zainstalować gdb
 
-[[debug_info]]
-==== Informacje diagnostyczne
+// TRANSLATION MISSING
+[[build_debug]]
+==== Build with debug options
 
 Jeśli kompilujesz z użyciem CMake:
 
@@ -396,6 +399,19 @@ Jeśli kompilujesz z użyciem CMake:
 $ cmake .. -DCMAKE_BUILD_TYPE=Debug
 ----
 
+// TRANSLATION MISSING
+You can additionally enable the address sanitizer, which causes WeeChat to
+crash immediately in case of problem:
+
+----
+$ cmake .. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_FLAGS=-fsanitize=address -DCMAKE_CXX_FLAGS=-fsanitize=address -DCMAKE_EXE_LINKER_FLAGS=-fsanitize=address
+----
+
+// TRANSLATION MISSING
+[WARNING]
+You should enable address sanitizer only if you're trying to cause a crash,
+this is not recommended in production.
+
 Jeśli zainstalowałeś pakiet binarny, doinstaluj paczkę _weechat-dbg_.
 
 [[core_files]]