summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJulien Gilli <julien.gilli@joyent.com>2014-11-14 10:58:54 -0800
committerChris Dickinson <christopher.s.dickinson@gmail.com>2014-11-14 12:33:34 -0800
commit5ff59453a483a43f1563504989f8e2d0ec253de1 (patch)
treedb470db99ad88a691cceaa9f370055158837b83d
parent88bd95cfef5973de0027b8eb5210e5e97252c7e2 (diff)
downloadnode-5ff59453a483a43f1563504989f8e2d0ec253de1.tar.gz
doc: clarify dns.lookup vs dns.resolve
Clarify and emphasize the differences between dns.lookup and the rest of the functions in the dns module. PR-URL: https://github.com/joyent/node/pull/8726 Reviewed-by: Chris Dickinson <christopher.s.dickinson@gmail.com>
-rw-r--r--doc/api/dns.markdown11
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/api/dns.markdown b/doc/api/dns.markdown
index efcf127e8..435516d4c 100644
--- a/doc/api/dns.markdown
+++ b/doc/api/dns.markdown
@@ -2,10 +2,13 @@
Stability: 3 - Stable
-Use `require('dns')` to access this module. All methods in the dns module
-use C-Ares except for `dns.lookup` which uses `getaddrinfo(3)` in a thread
-pool. C-Ares is much faster than `getaddrinfo` but the system resolver is
-more consistent with how other programs operate. When a user does
+Use `require('dns')` to access this module. All methods in the dns module use
+C-Ares except for `dns.lookup` which uses `getaddrinfo(3)` in a thread pool.
+C-Ares is much faster than `getaddrinfo(3)` but, due to the way it is
+configured by node, it doesn't use the same set of system configuration files.
+For instance, _C- Ares will not use the configuration from `/etc/hosts`_. As a
+result, __only `dns.lookup` should be expected to behave like other programs
+running on the same system regarding name resolution.__ When a user does
`net.connect(80, 'google.com')` or `http.get({ host: 'google.com' })` the
`dns.lookup` method is used. Users who need to do a large number of lookups
quickly should use the methods that go through C-Ares.