Opened 9 months ago

Closed 7 months ago

#31807 closed defect (fixed)

Update outdated documentation note for "bridge-distribution"

Reported by: phw Owned by:
Priority: Low Milestone: Tor: 0.4.2.x-final
Component: Core Tor/Tor Version:
Severity: Minor Keywords: BugSmashFund 042-can 042-backport
Cc: Actual Points: 0.2
Parent ID: Points: 0.2
Reviewer: teor Sponsor:


Tor's man page currently documents the BridgeDistribution option as:

       BridgeDistribution string
           If set along with BridgeRelay, Tor will include a new line in its bridge descriptor which indicates to the BridgeDB service how it would
           like its bridge address to be given out. Set it to "none" if you want BridgeDB to avoid distributing your bridge address, or "any" to let
           BridgeDB decide. (Default: any)

           Note: as of Oct 2017, the BridgeDB part of this option is not yet implemented. Until BridgeDB is updated to obey this option, your bridge
           will make this request, but it will not (yet) be obeyed.

Similarly, dir-spec.txt says about bridge-distribution-request:

        All bridges SHOULD include this line. Non-bridges MUST NOT include
        it.  (It is currently ignored by Bridge DB.)

BridgeDB however implements this option since 0.5.0, see #23957. I'll push a fix for these issues in a second.

Child Tickets

Change History (7)

comment:1 Changed 9 months ago by phw

Status: newneeds_review

Here's my fix for tor's man page:

And here's my fix for dir-spec.txt: (While I was at it, I also removed the "hyphae" bridge distribution method that was never finished.)

comment:2 Changed 9 months ago by nickm

Keywords: 042-can added
Milestone: Tor: 0.4.2.x-final

Documentation fixes can still go in 0.4.2, in spite of the feature freeze.

comment:3 Changed 8 months ago by nickm

Component: Core TorCore Tor/Tor

comment:4 Changed 7 months ago by dgoulet

Reviewer: teor

comment:5 Changed 7 months ago by teor

Actual Points: 0.2
Keywords: 042-backport added
Status: needs_reviewmerge_ready

I'll merge the tor and torspec changes when CI is a bit happier.

comment:6 Changed 7 months ago by teor

Merged the torspec branch to master.

comment:7 Changed 7 months ago by teor

Resolution: fixed
Status: merge_readyclosed

Merged the tor branch to 0.4.2 and later.
Merged #32106, #31807, #31001, #23818, #12399, and #31372 together.

Note: See TracTickets for help on using tickets.