[or-cvs] r9455: Make man page stop saying that BandwidthRate is for incoming (in tor/trunk: . doc src/or)

[nickm at seul.org]

Author: nickm
Date: 2007-01-29 13:13:34 -0500 (Mon, 29 Jan 2007)
New Revision: 9455

Modified:
   tor/trunk/
   tor/trunk/doc/tor.1.in
   tor/trunk/src/or/config.c
Log:
 r11583 at catbus:  nickm | 2007-01-29 11:19:48 -0500
 Make man page stop saying that BandwidthRate is for incoming bandwidth only; Add some XXX012s for config options that should maybe die.



Property changes on: tor/trunk
___________________________________________________________________
 svk:merge ticket from /tor/trunk [r11583] on 8246c3cf-6607-4228-993b-4d95d33730f1

Modified: tor/trunk/doc/tor.1.in
===================================================================
--- tor/trunk/doc/tor.1.in	2007-01-29 10:43:33 UTC (rev 9454)
+++ tor/trunk/doc/tor.1.in	2007-01-29 18:13:34 UTC (rev 9455)
@@ -58,13 +58,14 @@
 .LP
 .TP
 \fBBandwidthRate \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
-A token bucket limits the average incoming bandwidth on this node to
-the specified number of bytes per second. (Default: 3 MB)
+A token bucket limits the average bandwidth usage on this node to the
+specified number of bytes per second. (Default: 3 MB)
 .LP
 .TP
 \fBBandwidthBurst \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
 Limit the maximum token bucket size (also known as the burst) to the
-given number of bytes. (Default: 6 MB)
+given number of bytes. This value should be at least twice your
+BandwidthRate. (Default: 6 MB)
 .LP
 .TP
 \fBMaxAdvertisedBandwidth \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP

Modified: tor/trunk/src/or/config.c
===================================================================
--- tor/trunk/src/or/config.c	2007-01-29 10:43:33 UTC (rev 9454)
+++ tor/trunk/src/or/config.c	2007-01-29 18:13:34 UTC (rev 9455)
@@ -206,6 +206,7 @@
   VAR("ORListenAddress",     LINELIST, ORListenAddress,      NULL),
   VAR("ORPort",              UINT,     ORPort,               "0"),
   VAR("OutboundBindAddress", STRING,   OutboundBindAddress,  NULL),
+  /* XXXX012 mark this obsolete?  Warn if it's set? */
   VAR("PathlenCoinWeight",   DOUBLE,   PathlenCoinWeight,    "0.3"),
   VAR("PidFile",             STRING,   PidFile,              NULL),
   VAR("PreferTunneledDirConns", BOOL,  PreferTunneledDirConns, "0"),
@@ -218,7 +219,8 @@
   VAR("RecommendedVersions", LINELIST, RecommendedVersions,  NULL),
   VAR("RecommendedClientVersions", LINELIST, RecommendedClientVersions,  NULL),
   VAR("RecommendedServerVersions", LINELIST, RecommendedServerVersions,  NULL),
-  VAR("RedirectExit",        LINELIST, RedirectExit,         NULL),
+  VAR("RedirectExit",        LINELIST, RedirectExit,         NULL)
+  /* XXXX012 These aren't implemented. Take them out for now? */
   VAR("RelayBandwidthBurst", MEMUNIT,  RelayBandwidthBurst,  "0"),
   VAR("RelayBandwidthRate",  MEMUNIT,  RelayBandwidthRate,   "0"),
   VAR("RendExcludeNodes",    STRING,   RendExcludeNodes,     NULL),