Promise not to change fds in adns_beforepoll (if now is specified).

diff --git a/changelog b/changelog
index 9fba052ddb3fedec2fd14efbced9f411d767b6ed..3178a63f1d9b20fb31b84e0e3002ca268eb49f79 100644 (file)
--- a/changelog
+++ b/changelog
@@ -19,6 +19,7 @@ adns (0.5) unstable; urgency=medium
   * Don't complain so much about poll(2) tests if not available.
   * Do not give -u 0 -g 0 options to install.
   * Do not scramble innards when a query on the output queue is cancelled.
+  * Promise not to change fds in adns_beforepoll (if now is specified).
 
  --
 

diff --git a/src/adns.h b/src/adns.h
index 96eb0a5fd61073b66fcbf4290b717626237c46b8..dac2f57868ce4415c542c0c253b87cae63d4c7cd 100644 (file)
--- a/src/adns.h
+++ b/src/adns.h
@@ -553,7 +553,7 @@ int adns_beforepoll(adns_state ads, struct pollfd *fds, int *nfds_io, int *timeo
  * in *nfds_io, and always return either 0 (if it is not interested in
  * any fds) or ERANGE (if it is).
  *
- * NOTE that (unless timeout_io is 0) adns may acquire additional fds
+ * NOTE that (unless now is 0) adns may acquire additional fds
  * from one call to the next, so you must put adns_beforepoll in a
  * loop, rather than assuming that the second call (with the buffer
  * size requested by the first) will not return ERANGE.
@@ -574,9 +574,11 @@ int adns_beforepoll(adns_state ads, struct pollfd *fds, int *nfds_io, int *timeo
  * adns_beforepoll will return 0 on success, and will not fail for any
  * reason other than the fds buffer being too small (ERANGE).
  *
- * This call will never actually do any I/O, or change the fds that
- * adns is using or the timeouts it wants; and in any case it won't
- * block.
+ * This call will never actually do any I/O.  If you supply the
+ * current time it will not change the fds that adns is using or the
+ * timeouts it wants.
+ *
+ * In any case this call won't block.
  */
 
 #define ADNS_POLLFDS_RECOMMENDED 2