[svn] Document that the IP addresses are returned in order.

diff --git a/src/ChangeLog b/src/ChangeLog
index b41a146ba8d9e5e1249b276ad9d9b53b318b7ef9..028c0e86f178fabc2aa3c212108ceb84baff38c1 100644 (file)
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,8 @@
+2003-11-13  Hrvoje Niksic  <hniksic@xemacs.org>
+
+       * host.c (lookup_host): Document the fact that the addresses are
+       returned in order.
+
 2003-11-12  Hrvoje Niksic  <hniksic@xemacs.org>
 
        * utils.c: Use limits.h only where available.

diff --git a/src/host.c b/src/host.c
index 3e29ad98bb5d9c95db7b10f809055269bb4fc6fa..bb00cfa7721729a2d0e802d3229e91ca8d1c075a 100644 (file)
--- a/src/host.c
+++ b/src/host.c
@@ -82,8 +82,8 @@ extern int h_errno;
 
 static struct hash_table *host_name_addresses_map;
 \f
-/* Lists of addresses.  This should eventually be extended to handle
-   IPv6.  */
+/* Lists of IP addresses that result from running DNS queries.  See
+   lookup_host for details.  */
 
 struct address_list {
   int count;                   /* number of adrresses */
@@ -471,13 +471,14 @@ forget_host_lookup (const char *host)
     }
 }
 
-/* Look up HOST in DNS and return a list of IP addresses.
+/* Look up HOST in DNS and return a list of IP addresses.  The
+   addresses in the list are in the same order in which
+   gethostbyname/getaddrinfo returned them.
 
    This function caches its result so that, if the same host is passed
-   the second time, the addresses are returned without the DNS lookup.
-   If you want to force lookup, call forget_host_lookup() prior to
-   this function, or set opt.dns_cache to 0 to globally disable
-   caching.
+   the second time, the addresses are returned without DNS lookup.  If
+   you want to force lookup, call forget_host_lookup() prior to this
+   function, or set opt.dns_cache to 0 to globally disable caching.
 
    If SILENT is non-zero, progress messages are not printed.  */