Synx manpage and source wrt option capitalization

We had a spelling discrepancy between the manpage and the source code
for some option. Resolve these in favor of the manpage, because it
makes more sense (for example, HTTP should be capitalized).

diff --git a/changes/HTTP b/changes/HTTP
new file mode 100644 (file)
index 0000000..078d9b3
--- /dev/null
+++ b/changes/HTTP
@@ -0,0 +1,4 @@
+  o Code simplifications and refactoring:
+    - Some options used different conventions for uppercasing of acronyms
+      when comparing manpage and source. Fix those in favor of the
+      manpage, as it makes sense to capitalize acronyms.

diff --git a/src/or/config.c b/src/or/config.c
index 655af3797b048e316c1ec47e831b57dc5fd9db37..1339dd1a98f3c8eedc290fdff5e2afb31306cda6 100644 (file)
--- a/src/or/config.c
+++ b/src/or/config.c
@@ -83,7 +83,7 @@ static config_abbrev_t _option_abbrevs[] = {
   PLURAL(LongLivedPort),
   PLURAL(HiddenServiceNode),
   PLURAL(HiddenServiceExcludeNode),
-  PLURAL(NumCpu),
+  PLURAL(NumCPU),
   PLURAL(RendNode),
   PLURAL(RendExcludeNode),
   PLURAL(StrictEntryNode),
@@ -276,10 +276,10 @@ static config_var_t _option_vars[] = {
   V(HidServAuth,                 LINELIST, NULL),
   V(HSAuthoritativeDir,          BOOL,     "0"),
   OBSOLETE("HSAuthorityRecordStats"),
-  V(HttpProxy,                   STRING,   NULL),
-  V(HttpProxyAuthenticator,      STRING,   NULL),
-  V(HttpsProxy,                  STRING,   NULL),
-  V(HttpsProxyAuthenticator,     STRING,   NULL),
+  V(HTTPProxy,                   STRING,   NULL),
+  V(HTTPProxyAuthenticator,      STRING,   NULL),
+  V(HTTPSProxy,                  STRING,   NULL),
+  V(HTTPSProxyAuthenticator,     STRING,   NULL),
   V(Socks4Proxy,                 STRING,   NULL),
   V(Socks5Proxy,                 STRING,   NULL),
   V(Socks5ProxyUsername,         STRING,   NULL),
@@ -306,7 +306,7 @@ static config_var_t _option_vars[] = {
   V(WarnUnsafeSocks,              BOOL,     "1"),
   V(NoPublish,                   BOOL,     "0"),
   VAR("NodeFamily",              LINELIST, NodeFamilies,         NULL),
-  V(NumCpus,                     UINT,     "1"),
+  V(NumCPUs,                     UINT,     "1"),
   V(NumEntryGuards,              UINT,     "3"),
   V(ORListenAddress,             LINELIST, NULL),
   V(ORPort,                      UINT,     "0"),
@@ -3394,32 +3394,32 @@ options_validate(or_options_t *old_options, or_options_t *options,
   if (accounting_parse_options(options, 1)<0)
     REJECT("Failed to parse accounting options. See logs for details.");
 
-  if (options->HttpProxy) { /* parse it now */
-    if (tor_addr_port_parse(options->HttpProxy,
-                        &options->HttpProxyAddr, &options->HttpProxyPort) < 0)
-      REJECT("HttpProxy failed to parse or resolve. Please fix.");
-    if (options->HttpProxyPort == 0) { /* give it a default */
-      options->HttpProxyPort = 80;
+  if (options->HTTPProxy) { /* parse it now */
+    if (tor_addr_port_parse(options->HTTPProxy,
+                        &options->HTTPProxyAddr, &options->HTTPProxyPort) < 0)
+      REJECT("HTTPProxy failed to parse or resolve. Please fix.");
+    if (options->HTTPProxyPort == 0) { /* give it a default */
+      options->HTTPProxyPort = 80;
     }
   }
 
-  if (options->HttpProxyAuthenticator) {
-    if (strlen(options->HttpProxyAuthenticator) >= 48)
-      REJECT("HttpProxyAuthenticator is too long (>= 48 chars).");
+  if (options->HTTPProxyAuthenticator) {
+    if (strlen(options->HTTPProxyAuthenticator) >= 48)
+      REJECT("HTTPProxyAuthenticator is too long (>= 48 chars).");
   }
 
-  if (options->HttpsProxy) { /* parse it now */
-    if (tor_addr_port_parse(options->HttpsProxy,
-                        &options->HttpsProxyAddr, &options->HttpsProxyPort) <0)
-      REJECT("HttpsProxy failed to parse or resolve. Please fix.");
-    if (options->HttpsProxyPort == 0) { /* give it a default */
-      options->HttpsProxyPort = 443;
+  if (options->HTTPSProxy) { /* parse it now */
+    if (tor_addr_port_parse(options->HTTPSProxy,
+                        &options->HTTPSProxyAddr, &options->HTTPSProxyPort) <0)
+      REJECT("HTTPSProxy failed to parse or resolve. Please fix.");
+    if (options->HTTPSProxyPort == 0) { /* give it a default */
+      options->HTTPSProxyPort = 443;
     }
   }
 
-  if (options->HttpsProxyAuthenticator) {
-    if (strlen(options->HttpsProxyAuthenticator) >= 48)
-      REJECT("HttpsProxyAuthenticator is too long (>= 48 chars).");
+  if (options->HTTPSProxyAuthenticator) {
+    if (strlen(options->HTTPSProxyAuthenticator) >= 48)
+      REJECT("HTTPSProxyAuthenticator is too long (>= 48 chars).");
   }
 
   if (options->Socks4Proxy) { /* parse it now */
@@ -3616,10 +3616,10 @@ options_validate(or_options_t *old_options, or_options_t *options,
     REJECT("Must set TunnelDirConns if PreferTunneledDirConns is set.");
 
   if ((options->Socks4Proxy || options->Socks5Proxy) &&
-      !options->HttpProxy && !options->PreferTunneledDirConns)
+      !options->HTTPProxy && !options->PreferTunneledDirConns)
     REJECT("When Socks4Proxy or Socks5Proxy is configured, "
            "PreferTunneledDirConns and TunnelDirConns must both be "
-           "set to 1, or HttpProxy must be configured.");
+           "set to 1, or HTTPProxy must be configured.");
 
   if (options->AutomapHostsSuffixes) {
     SMARTLIST_FOREACH(options->AutomapHostsSuffixes, char *, suf,
@@ -3800,7 +3800,7 @@ options_transition_affects_workers(or_options_t *old_options,
                                    or_options_t *new_options)
 {
   if (!opt_streq(old_options->DataDirectory, new_options->DataDirectory) ||
-      old_options->NumCpus != new_options->NumCpus ||
+      old_options->NumCPUs != new_options->NumCPUs ||
       old_options->ORPort != new_options->ORPort ||
       old_options->ServerDNSSearchDomains !=
                                        new_options->ServerDNSSearchDomains ||

diff --git a/src/or/connection.c b/src/or/connection.c
index 91ce74b5b03a289e5e1bf9bd064c1b5e598ce93c..c19632daef83cc8de0664dc892614a92ad486004 100644 (file)
--- a/src/or/connection.c
+++ b/src/or/connection.c
@@ -579,7 +579,7 @@ connection_about_to_close_connection(connection_t *conn)
           or_options_t *options = get_options();
           rep_hist_note_connect_failed(or_conn->identity_digest, now);
           entry_guard_register_connect_status(or_conn->identity_digest,0,
-                                              !options->HttpsProxy, now);
+                                              !options->HTTPSProxy, now);
           if (conn->state >= OR_CONN_STATE_TLS_HANDSHAKING) {
             int reason = tls_error_to_orconn_end_reason(or_conn->tls_error);
             control_event_or_conn_status(or_conn, OR_CONN_EVENT_FAILED,
@@ -1370,7 +1370,7 @@ connection_proxy_connect(connection_t *conn, int type)
     case PROXY_CONNECT: {
       char buf[1024];
       char *base64_authenticator=NULL;
-      const char *authenticator = options->HttpsProxyAuthenticator;
+      const char *authenticator = options->HTTPSProxyAuthenticator;
 
       /* Send HTTP CONNECT and authentication (if available) in
        * one request */

diff --git a/src/or/connection_or.c b/src/or/connection_or.c
index 052da6763290620dc6c7ea7067634b61537e2e88..415a48dca3d5df5b248db4dd8f47a712110f2298 100644 (file)
--- a/src/or/connection_or.c
+++ b/src/or/connection_or.c
@@ -308,7 +308,7 @@ connection_or_finished_connecting(or_connection_t *or_conn)
 
   proxy_type = PROXY_NONE;
 
-  if (get_options()->HttpsProxy)
+  if (get_options()->HTTPSProxy)
     proxy_type = PROXY_CONNECT;
   else if (get_options()->Socks4Proxy)
     proxy_type = PROXY_SOCKS4;
@@ -805,10 +805,10 @@ connection_or_connect(const tor_addr_t *_addr, uint16_t port,
   control_event_or_conn_status(conn, OR_CONN_EVENT_LAUNCHED, 0);
 
   /* use a proxy server if available */
-  if (options->HttpsProxy) {
+  if (options->HTTPSProxy) {
     using_proxy = 1;
-    tor_addr_copy(&addr, &options->HttpsProxyAddr);
-    port = options->HttpsProxyPort;
+    tor_addr_copy(&addr, &options->HTTPSProxyAddr);
+    port = options->HTTPSProxyPort;
   } else if (options->Socks4Proxy) {
     using_proxy = 1;
     tor_addr_copy(&addr, &options->Socks4ProxyAddr);

diff --git a/src/or/cpuworker.c b/src/or/cpuworker.c
index 6f943d78b82f5e20b677a2334b57db84d213056c..ae8d69f6ec8889cb0a1de14b0c0ff683ef55fc1b 100644 (file)
--- a/src/or/cpuworker.c
+++ b/src/or/cpuworker.c
@@ -367,7 +367,7 @@ spawn_cpuworker(void)
 static void
 spawn_enough_cpuworkers(void)
 {
-  int num_cpuworkers_needed = get_options()->NumCpus;
+  int num_cpuworkers_needed = get_options()->NumCPUs;
 
   if (num_cpuworkers_needed < MIN_CPUWORKERS)
     num_cpuworkers_needed = MIN_CPUWORKERS;

diff --git a/src/or/directory.c b/src/or/directory.c
index b109cb53a79af016bdc7be7d0eaada33264f40f4..fbdd496c127f2fe378ff2d4c2809284a5825da10 100644 (file)
--- a/src/or/directory.c
+++ b/src/or/directory.c
@@ -819,7 +819,7 @@ directory_initiate_command_rend(const char *address, const tor_addr_t *_addr,
 
   /* ensure that we don't make direct connections when a SOCKS server is
    * configured. */
-  if (!anonymized_connection && !use_begindir && !options->HttpProxy &&
+  if (!anonymized_connection && !use_begindir && !options->HTTPProxy &&
       (options->Socks4Proxy || options->Socks5Proxy)) {
     log_warn(LD_DIR, "Cannot connect to a directory server through a "
                      "SOCKS proxy!");
@@ -850,9 +850,9 @@ directory_initiate_command_rend(const char *address, const tor_addr_t *_addr,
   if (!anonymized_connection && !use_begindir) {
     /* then we want to connect to dirport directly */
 
-    if (options->HttpProxy) {
-      tor_addr_copy(&addr, &options->HttpProxyAddr);
-      dir_port = options->HttpProxyPort;
+    if (options->HTTPProxy) {
+      tor_addr_copy(&addr, &options->HTTPProxyAddr);
+      dir_port = options->HTTPProxyPort;
     }
 
     switch (connection_connect(TO_CONN(conn), conn->_base.address, &addr,
@@ -1036,9 +1036,9 @@ directory_send_command(dir_connection_t *conn,
   }
 
   /* come up with some proxy lines, if we're using one. */
-  if (direct && get_options()->HttpProxy) {
+  if (direct && get_options()->HTTPProxy) {
     char *base64_authenticator=NULL;
-    const char *authenticator = get_options()->HttpProxyAuthenticator;
+    const char *authenticator = get_options()->HTTPProxyAuthenticator;
 
     tor_snprintf(proxystring, sizeof(proxystring),"http://%s", hoststring);
     if (authenticator) {

diff --git a/src/or/or.h b/src/or/or.h
index e4d57dd7bf45a5e56a3edc1ee3f06a72e8d0fcf9..14f050deb0c5f452cd25f36fe2e205a87d43b225 100644 (file)
--- a/src/or/or.h
+++ b/src/or/or.h
@@ -2547,7 +2547,7 @@ typedef struct {
                                  * use in a second for all relayed conns? */
   uint64_t PerConnBWRate; /**< Long-term bw on a single TLS conn, if set. */
   uint64_t PerConnBWBurst; /**< Allowed burst on a single TLS conn, if set. */
-  int NumCpus; /**< How many CPUs should we try to use? */
+  int NumCPUs; /**< How many CPUs should we try to use? */
 //int RunTesting; /**< If true, create testing circuits to measure how well the
 //                 * other ORs are running. */
   config_line_t *RendConfigLines; /**< List of configuration lines
@@ -2556,15 +2556,15 @@ typedef struct {
                                * authorizations for hidden services */
   char *ContactInfo; /**< Contact info to be published in the directory. */
 
-  char *HttpProxy; /**< hostname[:port] to use as http proxy, if any. */
-  tor_addr_t HttpProxyAddr; /**< Parsed IPv4 addr for http proxy, if any. */
-  uint16_t HttpProxyPort; /**< Parsed port for http proxy, if any. */
-  char *HttpProxyAuthenticator; /**< username:password string, if any. */
+  char *HTTPProxy; /**< hostname[:port] to use as http proxy, if any. */
+  tor_addr_t HTTPProxyAddr; /**< Parsed IPv4 addr for http proxy, if any. */
+  uint16_t HTTPProxyPort; /**< Parsed port for http proxy, if any. */
+  char *HTTPProxyAuthenticator; /**< username:password string, if any. */
 
-  char *HttpsProxy; /**< hostname[:port] to use as https proxy, if any. */
-  tor_addr_t HttpsProxyAddr; /**< Parsed addr for https proxy, if any. */
-  uint16_t HttpsProxyPort; /**< Parsed port for https proxy, if any. */
-  char *HttpsProxyAuthenticator; /**< username:password string, if any. */
+  char *HTTPSProxy; /**< hostname[:port] to use as https proxy, if any. */
+  tor_addr_t HTTPSProxyAddr; /**< Parsed addr for https proxy, if any. */
+  uint16_t HTTPSProxyPort; /**< Parsed port for https proxy, if any. */
+  char *HTTPSProxyAuthenticator; /**< username:password string, if any. */
 
   char *Socks4Proxy; /**< hostname:port to use as a SOCKS4 proxy, if any. */
   tor_addr_t Socks4ProxyAddr; /**< Derived from Socks4Proxy. */