X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=daemon.c;h=dd5420a6eab92de518e3af60ea49d094ae5db6bb;hb=2bad70d84e763b4d866d7b97dbc1cdc8e030bd45;hp=bfa81487430f62dc7417db6ba6e0c6d53c008051;hpb=53af5c6efb309565990203fd8504a812ec9166c9;p=paraslash.git

diff --git a/daemon.c b/daemon.c
index bfa81487..dd5420a6 100644
--- a/daemon.c
+++ b/daemon.c
@@ -58,9 +58,9 @@ static void daemon_set_default_log_colors(void)
 }
 
 /**
- * Set the color for one loglevel.
+ * Set the color for log messages of the given severity level.
  *
- * \param arg Must be of the form "ll:[fg [bg]] [attr]".
+ * \param arg Must be of the form "severity:[fg [bg]] [attr]".
  */
 void daemon_set_log_color_or_die(const char *arg)
 {
@@ -146,6 +146,22 @@ void daemon_set_loglevel(const char *loglevel)
 	me->loglevel = ret;
 }
 
+/**
+ * Register functions to be called before and after a message is logged.
+ *
+ * \param pre_log_hook Called before the message is logged.
+ * \param post_log_hook Called after the message is logged.
+ *
+ * The purpose of this function is to provide a primitive for multi-threaded
+ * applications to serialize the access to the log facility, preventing
+ * interleaving log messages. This can be achieved by having the pre-log hook
+ * acquire a lock which blocks the other threads on the attempt to log a
+ * message at the same time.  The post-log hook is responsible for releasing
+ * the lock.
+ *
+ * If these hooks are unnecessary, for example because the application is
+ * single-threaded, this function does not need to be called.
+ */
 void daemon_set_hooks(void (*pre_log_hook)(void), void (*post_log_hook)(void))
 {
 	me->pre_log_hook = pre_log_hook;