r11657@Kushana: nickm | 2006-12-20 15:11:19 -0500

 Fixes to check-docs script; add some docs; mark some options as deprecated in the online docs.


svn:r9163

contrib/checkOptionDocs.pl

@@ -12,12 +12,16 @@ my %manPageOptions = ();
 my $mostRecentOption;
 open(F, "./src/or/tor --list-torrc-options |") or die;
 while (<F>) {
-    next if m!/\[notice\] Tor v0\.!;
+    next if m!\[notice\] Tor v0\.!;
     if (m!^([A-Za-z0-9_]+)!) {
         $mostRecentOption = lc $1;
         $options{$mostRecentOption} = 1;
     } elsif (m!^    !) {
         $descOptions{$mostRecentOption} = 1;
+        if (m!\{DEPRECATED\}!) {
+            delete $descOptions{$mostRecentOption};
+            delete $options{$mostRecentOption};
+        }
     } else {
         print "Unrecognized output> ";
         print;

doc/tor.1.in

@@ -140,7 +140,7 @@ script to enumerate Tor nodes that exit to certain addresses.
 .LP
 .TP
 \fBGroup \fR\fIGID\fP
-On startup, setgid to this user.
+On startup, setgid to this group.
 .LP
 .TP
 \fBHttpProxy\fR \fIhost\fR[:\fIport\fR]\fP
@@ -231,6 +231,18 @@ On startup, setuid to this user.
 \fBHardwareAccel \fR\fB0\fR|\fB1\fP
 If non-zero, try to use crypto hardware acceleration when
 available. This is untested and probably buggy. (Default: 0)
+.LP
+.TP
+\fBAvoidDiskWrites \fR\fB0|\fR\fB1\fP
+If non-zero, try to write to disk less frequently than we would otherwise.
+This is useful when running on flash memory or other media that support only
+a limited number of writes.  (Default: 0)
+.LP
+.TP
+\fBTunnelDirConns \fR\fB0|\fR\fB1\fP
+If non-zero, try to have all directory info downloaded with encrypted
+connections.  (Default: 1)
+
 
 .SH CLIENT OPTIONS
 .PP

src/or/config.c

@@ -302,7 +302,8 @@ typedef struct config_var_description_t {
 
 static config_var_description_t options_description[] = {
   /* ==== general options */
-  /* AvoidDiskWrites */
+  { "AvoidDiskWrites", "If non-zero, try to write to disk less frequently than"
+    " we would otherwise." },
   { "BandwidthRate", "A token bucket limits the average incoming bandwidth on "
     "this node to the specified number of bytes per second." },
   { "BandwidthBurst", "Limit the maximum token buffer size (also known as "
@@ -317,6 +318,7 @@ static config_var_description_t options_description[] = {
     "connections to the control port except when the connecting process "
     "can read a file that Tor creates in its data directory. " },
   { "DataDirectory", "Store working data, state, keys, and caches here." },
+  { "DebugLogFile", "{DEPRECATED}" },
   { "DirServer", "Tor only trusts directories signed with one of these "
     "servers' keys.  Used to override the standard list of directory "
     "authorities." },
@@ -339,6 +341,8 @@ static config_var_description_t options_description[] = {
     "from closing our connections while Tor is not in use." },
   { "Log", "Where to send logging messages.  Format is "
     "minSeverity[-maxSeverity] (stderr|stdout|syslog|file FILENAME)." },
+  { "LogLevel", "{DEPRECATED} " },
+  { "LogFile", "{DEPRECATED} " },
   { "OutboundBindAddress", "Make all outbound connections originate from the "
     "provided IP address (only usefol for multiple network interfaces)." },
   { "PIDFile", "On startup, write our PID to this file. On clean shutdown, "
@@ -349,7 +353,9 @@ static config_var_description_t options_description[] = {
     "started.  Unix only." },
   { "SafeLogging", "If set to 0, Tor logs potentially sensitive strings "
     "rather than replacing them with the string [scrubbed]." },
-  /* TunnelDirConns */
+  { "SysLog", "{DEPRECATED}" },
+  { "TunnelDirConns", "If non-zero, try to have all directory info downloaded "
+    "via encrypted connections." },
   { "User", "On startup, setuid to this user" },
 
   /* ==== client options */
@@ -413,6 +419,7 @@ static config_var_description_t options_description[] = {
 
   /* === server options */
   { "Address", "The advertised (external) address we should use." },
+  { "AccountingMaxKB", "{DEPRECATED}" },
   /* Accounting* options. */
   /* AssumeReachable */
   { "ContactInfo", "Administrative contact information to advertise for this "
@@ -429,15 +436,15 @@ static config_var_description_t options_description[] = {
     "family as this one, so that clients will not use two from the same "
     "family in the same circuit." },
   { "Nickname", "Set the server nickname." },
-  { "NoPublish", "Set to 1 in order to keep the server from uploading info "
-    "to the directory authorities.  This prevents clients from using your "
-    "server." },
+  { "NoPublish", "{DEPRECATED}" },
   { "NumCPUs", "How many processes to use at once for public-key crypto." },
   { "ORPort", "Advertise this port to listen for connections from Tor clients "
     "and servers." },
   { "ORListenAddress", "Bind to this address to listen for connections from "
     "clients and servers, instead of the default 0.0.0.0:ORPort." },
-  /* PublishServerDescriptor */
+  { "PublishServerDescriptors", "Set to 0 in order to keep the server from "
+    "uploading info to the directory authorities.  This prevents clients "
+    "from using your server." },
   /*{ "RedirectExit", "When an outgoing connection tries to connect to a "
    *"given address, redirect it to another address instead." },
    */