document log message format

[adns.git] / src / adns.h

diff --git a/src/adns.h b/src/adns.h
index 99e32b109cf6ece9ac434d7632947b7724fe8bfd..9be8b68d0b327d1bc8b15c2cef0ba1864254a3ad 100644 (file)
--- a/src/adns.h
+++ b/src/adns.h
@@ -363,6 +363,11 @@ int adns_init_strcfg(adns_state *newstate_r, adns_initflags flags,
 
 typedef void adns_logcallbackfn(adns_state ads, void *logfndata,
                                const char *fmt, va_list al);
+  /* Will be called perhaps several times for each message; when the
+   * message is complete, the string implied by fmt and al will end in
+   * a newline.  Log messages start with `adns debug:' or `adns
+   * warning:' or `adns:' (for errors), or `adns debug [PID]:'
+   * etc. if adns_if_logpid is set. */
 
 int adns_init_logfn(adns_state *newstate_r, adns_initflags flags,
                    const char *configtext /*0=>use default config files*/,