Clarify event_enable_debug_logging a little

diff --git a/include/event2/event.h b/include/event2/event.h
index f71d0844c67b2921bffcfe9b67399c2cbeaa820b..415116ed3cea52a0002de7f171d8a096b4ac6f8e 100644 (file)
--- 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);