Opened 9 years ago

Closed 9 years ago

Last modified 8 years ago

#3529 closed defect (fixed)

Move obsolete specs to attic/ subdirectory

Reported by: atagar Owned by:
Priority: Low Milestone:
Component: Core Tor/Tor Version:
Severity: Keywords: tor-relay
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

The bridge spec [1] suggests that bridges have both...
BridgeRelay 1
PublishServerDescriptor bridge

in their torrc. The second is pointless and, according to Roger and Robert, this spec is kinda obsolete:

18:41 < atagar> The 'BridgeRelay 1' and 'PublishServerDescriptor bridge' seems kinda redundant. The bridge spec says to use both but the man page entry for 'BridgeRelay' says...
18:41 < atagar> 'It mainly causes Tor to publish a server descriptor to the bridge database, rather than publishing a relay descriptor to the public directory authorities.'
18:41 < atagar> Is the former just an alias for the second? Is there a reason we suggest that both are used?
18:44 < rransom> atagar: Use 'BridgeRelay 1'.
18:45 < rransom
> 'PublishServerDescriptor bridge' doesn't make a relay answer directory requests.
18:52 < atagar> thanks - we should change that in the spec
18:52 * atagar will submit a ticket when he's on a connection that doesn't have 40-second-per-character latency
21:57 < armadev> atagar: the bridge spec is not what you should look at to decide how to configure your bridge. it's obsolete in that respect.
21:57 < armadev> for example, you don't need to touch publishserverdescriptor. it will automatically do the right thing.
22:38 < atagar> armadev: you still want to set it to zero for a private bridge, right?
22:39 < rransom> Yes.
22:40 < atagar> 'not what you should look at to decide how to configure your bridge' -> What is? Is the torrc setup for bridges in an faq? (after a quick search it seemed like the spec was the best description we had)
22:41 < rransom
> bridge-spec.txt is obsolete.
22:42 < atagar> we should lable it as such, then
22:42 < rransom> https://www.torproject.org/docs/bridges is about how to configure a bridge.

We should correct the spec, label it as being obsolete, or remove it to avoid future confusion.

[1] https://gitweb.torproject.org/torspec.git?a=blob_plain;hb=HEAD;f=bridges-spec.txt

Child Tickets

Change History (6)

comment:1 Changed 9 years ago by rransom

Summary: Needless Torrc Entries in Bridge SpecMove obsolete specs to attic/ subdirectory

bridges-spec.txt is definitely not the only obsolete spec in torspec.git.

comment:2 Changed 9 years ago by arma

I think moving bridges-spec to an attic is a great idea.

Robert, what other specs did you have in mind? I guess the v0 control spec and the v1 and v2 dir specs?

Looking back, bridges-spec.txt is an instance of what we later started calling a "proposal". Maybe we should just retroactively move it there.

comment:3 in reply to:  2 Changed 9 years ago by rransom

Replying to arma:

I think moving bridges-spec to an attic is a great idea.

Robert, what other specs did you have in mind? I guess the v0 control spec and the v1 and v2 dir specs?

control-spec-v0.txt and dir-spec-v1.txt should be moved to the attic, but as I understand it, dir-spec-v2.txt is still in use.

comment:4 Changed 9 years ago by nickm

Resolution: fixed
Status: newclosed

done; please make any other changes you want, arma.

comment:5 Changed 8 years ago by nickm

Keywords: tor-relay added

comment:6 Changed 8 years ago by nickm

Component: Tor RelayTor
Note: See TracTickets for help on using tickets.