Opened 2 months ago

Closed 2 weeks ago

#25296 closed defect (fixed)

update PerConnBWRate/Burst manpage entries to not mention consensus

Reported by: cypherpunks Owned by:
Priority: Medium Milestone: Tor: 0.3.4.x-final
Component: Core Tor/Tor Version:
Severity: Minor Keywords: tor-doc, 032-backport, 033-backport, 034-triage-20180328
Cc: Actual Points:
Parent ID: Points:
Reviewer: asn Sponsor:

Description

context:
https://lists.torproject.org/pipermail/tor-relays/2018-February/014585.html

The manpage says that relays will use the value in consensus but the consensus does not longer include these values.

This patch removes "You should never need to change this value, since a network-wide value is published in the consensus and your relay will use that value."

and is the minimal change, but it would be better to add more information that says if tor has some built-in mechanism to avoid that a single client uses all bw.
Also: How does tor tell non-relays from relays apart?

@@ -243,13 +243,11 @@
 
 [[PerConnBWRate]] **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
     If set, do separate rate limiting for each connection from a non-relay.
-    You should never need to change this value, since a network-wide value is
-    published in the consensus and your relay will use that value. (Default: 0)
+    (Default: 0)
 
 [[PerConnBWBurst]] **PerConnBWBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
     If set, do separate rate limiting for each connection from a non-relay.
-    You should never need to change this value, since a network-wide value is
-    published in the consensus and your relay will use that value. (Default: 0)
+    (Default: 0)
 
 [[ClientTransportPlugin]] **ClientTransportPlugin** __transport__ socks4|socks5 __IP__:__PORT__::
 **ClientTransportPlugin** __transport__ exec __path-to-binary__ [options]::

Child Tickets

Change History (7)

comment:1 Changed 7 weeks ago by nickm

Milestone: Tor: 0.3.4.x-final
Status: newneeds_review

comment:2 Changed 7 weeks ago by teor

Keywords: 032-backport 033-backport added
Status: needs_reviewmerge_ready

This patch seems fine to me, marking for backport to 0.3.3 and 0.3.2, because this documentation has confused at least one relay operator.

but it would be better to add more information that says if tor has some built-in mechanism to avoid that a single client uses all bw

Tor has a circuit scheduler that tries to allocate bandwidth to low-volume circuits.

Also: How does tor tell non-relays from relays apart?

Relays authenticate, clients and bridges do not.

comment:3 Changed 5 weeks ago by nickm

Status: merge_readyneeds_review

I think this isn't quite right, though: we should still document that the perconnbwrate/burst options _will_ be used if they _are_ set in the consensus.

What do you think of the branch in my public repository called ticket25296_032 ?

comment:4 Changed 3 weeks ago by nickm

Keywords: 034-triage-20180328 added

comment:5 Changed 2 weeks ago by asn

Reviewer: asn

comment:6 in reply to:  3 Changed 2 weeks ago by asn

Replying to nickm:

I think this isn't quite right, though: we should still document that the perconnbwrate/burst options _will_ be used if they _are_ set in the consensus.

What do you think of the branch in my public repository called ticket25296_032 ?

Phrasing looks good to me. There is a copy/paste fail which I corrected in my branch ticket25296_032 in my github repo. Please check it out and merge it.

comment:7 Changed 2 weeks ago by nickm

Resolution: fixed
Status: needs_reviewclosed

Squashed and merged to 0.3.2 and forward!

Note: See TracTickets for help on using tickets.