Rename ServerDNSAllowBrokenResolvConf to ServerDNSAllowBrokenConfig.

(Many users have no idea what a resolv.conf is, and shouldn't be forced to learn.  The old option will keep working for now.)
Also, document it.

svn:r17661

5 files changed, 16 insertions, 5 deletions

diff --git a/ChangeLog b/ChangeLog
index 35896969ff..d0e3da14e7 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -78,6 +78,8 @@ Changes in version 0.2.1.9-alpha - 2008-12-2?
     - Move edge-only flags from connection_t to edge_connection_t: not
       only is this better coding, but on machines of plausible alignment,
       it should save 4-8 bytes per connection_t. "Every little bit helps."
+    - Rename ServerDNSAllowBrokenResolvConf to ServerDNSAllowBrokenConfig
+      for consistency; keep old option working for backward compatibility.
 
 
 Changes in version 0.2.1.8-alpha - 2008-12-08
diff --git a/doc/tor.1.in b/doc/tor.1.in
index b723110a1a..76c8b47c8b 100644
--- a/doc/tor.1.in
+++ b/doc/tor.1.in
@@ -975,6 +975,14 @@ ServerDNS options, only affects name lookups that your server does on
 behalf of clients. (Defaults to use the system DNS configuration.)
 .LP
 .TP
+\fBServerDNSAllowBrokenConfig \fR\fB0\fR|\fB1\fR\fP
+If this option is false, Tor exits immediately if there are problems
+parsing the system DNS configuration or connecting to nameservers.
+Otherwise, Tor continues to periodically retry the system namesevers
+until it eventually succeeds.
+(Defaults to "1".)
+.LP
+.TP
 \fBServerDNSSearchDomains \fR\fB0\fR|\fB1\fR\fP
 If set to \fB1\fP, then we will search for addresses in the local search
 domain.  For example, if this system is configured to believe it is in
@@ -1332,7 +1340,7 @@ non-default set of DirServers is set. Cannot be unset while Tor is running.
 
 .PD 0
 .RS 12
-.IP "ServerDNSAllowBrokenResolvConf 1"
+.IP "ServerDNSAllowBrokenConfig 1"
 .IP "DirAllowPrivateAddresses 1"
 .IP "EnforceDistinctSubnets 0"
 .IP "AssumeReachable 1"
diff --git a/src/or/config.c b/src/or/config.c
index 3c224eee62..0dd9a0f03f 100644
--- a/src/or/config.c
+++ b/src/or/config.c
@@ -85,6 +85,7 @@ static config_abbrev_t _option_abbrevs[] = {
   { "NumEntryNodes", "NumEntryGuards", 0, 0},
   { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
   { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
+  { "ServerDNSAllowBrokenResolvConf", "SeverDNSAllowBrokenConfig", 0, 0 },
   { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
   { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
   { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
@@ -290,7 +291,7 @@ static config_var_t _option_vars[] = {
   V(RunTesting,                  BOOL,     "0"),
   V(SafeLogging,                 BOOL,     "1"),
   V(SafeSocks,                   BOOL,     "0"),
-  V(ServerDNSAllowBrokenResolvConf, BOOL,  "1"),
+  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
   V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
   V(ServerDNSDetectHijacking,    BOOL,     "1"),
   V(ServerDNSRandomizeCase,      BOOL,     "1"),
@@ -345,7 +346,7 @@ static config_var_t _option_vars[] = {
 
 /* Keep defaults synchronous with man page and config value check. */
 static config_var_t testing_tor_network_defaults[] = {
-  V(ServerDNSAllowBrokenResolvConf, BOOL,  "1"),
+  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
   V(DirAllowPrivateAddresses,    BOOL,     "1"),
   V(EnforceDistinctSubnets,      BOOL,     "0"),
   V(AssumeReachable,             BOOL,     "1"),
diff --git a/src/or/main.c b/src/or/main.c
index fbf96037ed..a84a62d6ac 100644
--- a/src/or/main.c
+++ b/src/or/main.c
@@ -1386,7 +1386,7 @@ do_main_loop(void)
 
   /* initialize dns resolve map, spawn workers if needed */
   if (dns_init() < 0) {
-    if (get_options()->ServerDNSAllowBrokenResolvConf)
+    if (get_options()->ServerDNSAllowBrokenConfig)
       log_warn(LD_GENERAL, "Couldn't set up any working nameservers. "
                "Network not up yet?  Will try again soon.");
     else {
diff --git a/src/or/or.h b/src/or/or.h
index cea0cf15c9..999e8ddbab 100644
--- a/src/or/or.h
+++ b/src/or/or.h
@@ -2462,7 +2462,7 @@ typedef struct {
                     will know this without any specialized knowledge. */
   /** Boolean: if set, we start even if our resolv.conf file is missing
    * or broken. */
-  int ServerDNSAllowBrokenResolvConf;
+  int ServerDNSAllowBrokenConfig;
 
   smartlist_t *ServerDNSTestAddresses; /**< A list of addresses that definitely
                                         * should be resolveable. Used for