From: ian <ian>
Date: Mon, 3 Apr 2006 23:47:41 +0000 (+0000)
Subject: +  * Document in adns.h EINVAL from adns_init meaning bad configuration.
X-Git-Tag: adns-1.5.0-rc0~153
X-Git-Url: https://git.distorted.org.uk/~mdw/adns/commitdiff_plain/refs/tags/before-srv-2006-04-04

+  * 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 6467c9e..70ac646 100644
--- 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 1a7d1dc..b69a20b 100644
--- 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