+ * Document in adns.h EINVAL from adns_init meaning bad configuration.

[adns] / src / adns.h

diff --git a/src/adns.h b/src/adns.h
index 1a7d1dce2f71248215fdce43540c0086652deb07..b69a20b12134c8d2594e88d42488549f6aea3cdf 100644 (file)
--- a/src/adns.h
+++ b/src/adns.h
@@ -340,7 +340,8 @@ typedef struct {
  *
  *  For _init, _init_strcfg, _submit and _synchronous, system errors
  *  (eg, failure to create sockets, malloc failure, etc.) return errno
- *  values.
+ *  values.  EINVAL from _init et al means the configuration file
+ *  is erroneous and cannot be parsed.
  * 
  *  For _wait and _check failures are reported in the answer
  *  structure, and only 0, ESRCH or (for _check) EAGAIN is