core: add documentation on command line debug options (in --help and man pages)

Command line debug options are now documented:

* --no-dlclose: do not call the function dlclose after plugins are unloaded
* --no-gnutls: do not call the init and deinit functions of GnuTLS library
* --no-gcrypt: do not call the init and deinit functions of Gcrypt library

These options must not be used in production, they're for debug only and can be
used with tools like Valgrind or electric-fence.

6 files changed, 52 insertions, 9 deletions

diff --git a/doc/it/CMakeLists.txt b/doc/it/CMakeLists.txt
index 963565c19..f9a22864e 100644
--- a/doc/it/CMakeLists.txt
+++ b/doc/it/CMakeLists.txt
@@ -25,6 +25,7 @@ if(ENABLE_MAN)
     DEPENDS
     ${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.it.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.it.adoc
+    ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options_debug.it.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_plugin_options.it.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_files.it.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_copyright.it.adoc
@@ -41,6 +42,7 @@ if(ENABLE_MAN)
     DEPENDS
     ${CMAKE_CURRENT_SOURCE_DIR}/weechat-headless.1.it.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.it.adoc
+    ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options_debug.it.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_plugin_options.it.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_files.it.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_copyright.it.adoc
@@ -64,6 +66,7 @@ if(ENABLE_DOC)
     ${CMAKE_CURRENT_SOURCE_DIR}/../docinfo.html
     ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.it.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.it.adoc
+    ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options_debug.it.adoc
     ${AUTOGEN_USER}
     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
     COMMENT "Building weechat_user.it.html"
diff --git a/doc/it/Makefile.am b/doc/it/Makefile.am
index abd88a925..d9087a799 100644
--- a/doc/it/Makefile.am
+++ b/doc/it/Makefile.am
@@ -24,6 +24,7 @@ EXTRA_DIST = CMakeLists.txt \
              weechat.1.it.adoc \
              weechat-headless.1.it.adoc \
              cmdline_options.it.adoc \
+             cmdline_options_debug.it.adoc \
              weechat_user.it.adoc \
              weechat_plugin_api.it.adoc \
              weechat_scripting.it.adoc \
@@ -52,13 +53,13 @@ endif
 all-local: $(man_targets) $(doc_targets)
 
 # man pages
-weechat.1: weechat.1.it.adoc cmdline_options.it.adoc
+weechat.1: weechat.1.it.adoc cmdline_options.it.adoc cmdline_options_debug.it.adoc
 	$(ASCIIDOCTOR) -a revision="WeeChat $(VERSION)" -b manpage -o weechat.1 $(abs_top_srcdir)/doc/it/weechat.1.it.adoc
-weechat-headless.1: weechat-headless.1.it.adoc cmdline_options.it.adoc
+weechat-headless.1: weechat-headless.1.it.adoc cmdline_options.it.adoc cmdline_options_debug.it.adoc
 	$(ASCIIDOCTOR) -a revision="WeeChat $(VERSION)" -b manpage -o weechat-headless.1 $(abs_top_srcdir)/doc/it/weechat-headless.1.it.adoc
 
 # user's guide
-weechat_user.it.html: weechat_user.it.adoc cmdline_options.it.adoc $(wildcard autogen/user/*.adoc) $(abs_top_srcdir)/doc/docinfo.html
+weechat_user.it.html: weechat_user.it.adoc cmdline_options.it.adoc cmdline_options_debug.it.adoc $(wildcard autogen/user/*.adoc) $(abs_top_srcdir)/doc/docinfo.html
 	$(ASCIIDOCTOR) -a revision="$(VERSION)" -a sectanchors -a source-highlighter=prettify -o weechat_user.it.html $(abs_top_srcdir)/doc/it/weechat_user.it.adoc
 
 # plugin API reference
diff --git a/doc/it/cmdline_options_debug.it.adoc b/doc/it/cmdline_options_debug.it.adoc
new file mode 100644
index 000000000..5e88ef3ae
--- /dev/null
+++ b/doc/it/cmdline_options_debug.it.adoc
@@ -0,0 +1,16 @@
+// TRANSLATION MISSING
+*--no-dlclose*::
+    Do not call the function dlclose after plugins are unloaded.
+    This is useful with tools like Valgrind to display stack for unloaded
+    plugins.
+
+// TRANSLATION MISSING
+*--no-gnutls*::
+    Do not call the init and deinit functions of GnuTLS library.
+    This is useful with tools like Valgrind and electric-fence, to prevent
+    GnuTLS memory errors.
+
+// TRANSLATION MISSING
+*--no-gcrypt*::
+    Do not call the init and deinit functions of Gcrypt library.
+    This is useful with tools like Valgrind, to prevent Gcrypt memory errors.
diff --git a/doc/it/weechat-headless.1.it.adoc b/doc/it/weechat-headless.1.it.adoc
index 241bf516c..d8401aec1 100644
--- a/doc/it/weechat-headless.1.it.adoc
+++ b/doc/it/weechat-headless.1.it.adoc
@@ -16,7 +16,7 @@ weechat-headless - the extensible chat client (headless version)
 
 // TRANSLATION MISSING
 [verse]
-*weechat-headless* [-a|--no-connect] [--daemon] [-d|--dir <path>] [-t|--temp-dir] [-p|--no-plugin] [-P|--plugins <plugins>] [-r|--run-command <command>] [-s|--no-script] [--upgrade] [plugin:option...]
+*weechat-headless* [-a|--no-connect] [--daemon] [-d|--dir <path>] [-t|--temp-dir] [-p|--no-plugin] [-P|--plugins <plugins>] [-r|--run-command <command>] [-s|--no-script] [--upgrade] [debug-option...] [plugin:option...]
 *weechat-headless* [-c|--colors]
 *weechat-headless* [-h|--help]
 *weechat-headless* [-l|--license]
@@ -37,6 +37,13 @@ It can be used for tests or to daemonize WeeChat with the option "--daemon".
 
 include::cmdline_options.it.adoc[]
 
+// TRANSLATION MISSING
+== DEBUG OPTIONS
+
+*WARNING:* these options are for debug purposes only, *DO NOT USE IN PRODUCTION!*
+
+include::cmdline_options_debug.it.adoc[]
+
 == PLUGIN OPTIONS
 
 include::man_plugin_options.it.adoc[]
diff --git a/doc/it/weechat.1.it.adoc b/doc/it/weechat.1.it.adoc
index 659026c1e..8393614e8 100644
--- a/doc/it/weechat.1.it.adoc
+++ b/doc/it/weechat.1.it.adoc
@@ -16,7 +16,7 @@ weechat - the extensible chat client
 
 // TRANSLATION MISSING
 [verse]
-*weechat* [-a|--no-connect] [-d|--dir <path>] [-t|--temp-dir]  [-p|--no-plugin] [-P|--plugins <plugins>] [-r|--run-command <command>] [-s|--no-script] [--upgrade] [plugin:option...]
+*weechat* [-a|--no-connect] [-d|--dir <path>] [-t|--temp-dir]  [-p|--no-plugin] [-P|--plugins <plugins>] [-r|--run-command <command>] [-s|--no-script] [--upgrade] [debug-option...] [plugin:option...]
 *weechat* [-c|--colors]
 *weechat* [-h|--help]
 *weechat* [-l|--license]
@@ -33,6 +33,13 @@ It is highly customizable and extensible with scripts.
 
 include::cmdline_options.it.adoc[]
 
+// TRANSLATION MISSING
+== DEBUG OPTIONS
+
+*WARNING:* these options are for debug purposes only, *DO NOT USE IN PRODUCTION!*
+
+include::cmdline_options_debug.it.adoc[]
+
 == PLUGIN OPTIONS
 
 include::man_plugin_options.it.adoc[]
diff --git a/doc/it/weechat_user.it.adoc b/doc/it/weechat_user.it.adoc
index 7438050f7..478b42206 100644
--- a/doc/it/weechat_user.it.adoc
+++ b/doc/it/weechat_user.it.adoc
@@ -548,16 +548,25 @@ Per avviare WeeChat, digitare questo comando:
 $ weechat
 ----
 
-Argomenti a riga di comando:
-
-include::cmdline_options.it.adoc[]
-
 // TRANSLATION MISSING
 When you run WeeChat for the first time, the default configuration files are
 created in _~/.weechat_ with default options and values
 (see <<files_and_directories,Files and directories>>).
 
 // TRANSLATION MISSING
+==== Command line options
+
+include::cmdline_options.it.adoc[]
+
+// TRANSLATION MISSING
+==== Extra debug options
+
+[WARNING]
+These options are for debug purposes only, *DO NOT USE IN PRODUCTION!*
+
+include::cmdline_options_debug.it.adoc[]
+
+// TRANSLATION MISSING
 [[environment_variables]]
 === Environment variables