From c6fa14f4fe10f04e1b9a4c231caa8054e0c7224d Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Sat, 27 Dec 2014 09:49:37 +0000 Subject: [PATCH] agent: Document G_MESSAGES_DEBUG and NICE_DEBUG As requested on the mailing list, expand the documentation for nice_debug_enable() to mention them. --- agent/debug.h | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/agent/debug.h b/agent/debug.h index 22c22f6..20816e8 100644 --- a/agent/debug.h +++ b/agent/debug.h @@ -75,9 +75,19 @@ G_BEGIN_DECLS /** * nice_debug_enable: - * @with_stun: Also enable stun debugging messages + * @with_stun: Also enable STUN debugging messages * - * Enables libnice debug output to the terminal + * Enables libnice debug output to the terminal. Note that the + * `G_MESSAGES_DEBUG` and `NICE_DEBUG` environment variables must be set to the + * set of logging domains to print, in order for any output to be printed. Set + * them to `all` to print all debugging messages, or any of the following + * domains: + * - `libnice-stun` + * - `libnice-tests` + * - `libnice-socket` + * - `libnice` + * - `libnice-pseudotcp` + * - `libnice-pseudotcp-verbose` */ void nice_debug_enable (gboolean with_stun); -- 2.7.4