From fea4fb28cb464346f546109b4994136ce5f65f4f Mon Sep 17 00:00:00 2001
From: hniksic <devnull@localhost>
Date: Wed, 12 Nov 2003 17:37:46 -0800
Subject: [PATCH] [svn] Document that the IP addresses are returned in order.
---
src/ChangeLog | 5 +++++
src/host.c | 15 ++++++++-------
2 files changed, 13 insertions(+), 7 deletions(-)
diff --git a/src/ChangeLog b/src/ChangeLog
index b41a146b..028c0e86 100644
--- 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 3e29ad98..bb00cfa7 100644
--- a/src/host.c
+++ b/src/host.c
@@ -82,8 +82,8 @@ extern int h_errno;
static struct hash_table *host_name_addresses_map;
-/* 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. */