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

@@ -9,6 +9,7 @@ adns (1.1.999.0.2); urgency=medium
   * adnstest converts some errno values to EFOOBAR: all of the ones
     mentioned in adns.h, at least.  This makes the regression test
     more portable (fixes problem noticed by Bernd Eckenfels).
+  * Document in adns.h EINVAL from adns_init meaning bad configuration.

   Fixes from or suggested by Bernd Eckenfels, the Debian maintainer:
   * Correct type of various printf arguments: ptrdiff_t != int.

diff --git a/changelog b/changelog
index 6467c9e2fbca06c7d9acafe0a665c7c4a810779c..70ac646645e19baa2af33ea76861f28fb54303c8 100644 (file)
--- a/changelog
+++ b/changelog
@@ -9,6 +9,7 @@ adns (1.1.999.0.2); urgency=medium
   * adnstest converts some errno values to EFOOBAR: all of the ones
     mentioned in adns.h, at least.  This makes the regression test
     more portable (fixes problem noticed by Bernd Eckenfels).
+  * Document in adns.h EINVAL from adns_init meaning bad configuration.
 
   Fixes from or suggested by Bernd Eckenfels, the Debian maintainer:
   * Correct type of various printf arguments: ptrdiff_t != int.

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