From: Nick Mathewson <nickm@torproject.org>
Date: Mon, 12 Sep 2011 15:31:02 +0000 (-0400)
Subject: Clarify event_enable_debug_logging a little
X-Git-Tag: release-2.1.1-alpha~199^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=6207826e708e131efca23f7db53d181fe87c9b23;p=libevent

Clarify event_enable_debug_logging a little
---

diff --git a/include/event2/event.h b/include/event2/event.h
index f71d0844..415116ed 100644
--- a/include/event2/event.h
+++ b/include/event2/event.h
@@ -314,18 +314,21 @@ typedef void (*event_fatal_cb)(int err);
 void event_set_fatal_callback(event_fatal_cb cb);
 
 #define EVENT_DBG_ALL 0xffffffffu
+#define EVENT_DBG_NONE 0
 
 /**
  Turn on debugging logs and have them sent to the default log handler.
 
- This is a global setting; you must call this before any calls that create an
- event-base.
+ This is a global setting; if you are going to call it, you must call this
+ before any calls that create an event-base.  You must call it before any
+ multithreaded use of Libevent.
 
  Debug logs are verbose.
 
  @param which Controls which debug messages are turned on.  This option is
    unused for now; for forward compatibility, you must pass in the constant
-   "EVENT_DBG_ALL"
+   "EVENT_DBG_ALL" to turn debugging logs on, or "EVENT_DBG_NONE" to turn
+   debugging logs off.
  */
 void event_enable_debug_logging(ev_uint32_t which);