Opened 4 years ago

Last modified 19 months ago

#14987 new defect

Settle on a name for descriptors

Reported by: atagar Owned by: nickm
Priority: Low Milestone: Tor: unspecified
Component: Core Tor/Tor Version:
Severity: Normal Keywords:
Cc: karsten, sebastian, nickm Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

As discussed on #14784 we call self-published descriptors quite a few things...

  • 'GETINFO desc/*' and Stem call the main self-published descriptors server descriptors. Metrics also uses a "server-descriptor 1.0" annotation for them.
  • The dir-spec calls them router descriptors... usually. It opts for 'server descriptor' in section 6.2.
  • CollecTor calls them relay descriptors.

Having three different names is confusing for new contributors and... well, us too. We should standardize on a name.

This primarily straddles Tor's spec, Stem, and CollecTor. Personally I'd like for us to standardize on server descriptors because it's codified in the Metrics annotation and classes Stem vends.

Karsten, Nick: any objections? If not then I'm happy to provide a spec patch and file a CollecTor ticket for this.

Child Tickets

Change History (17)

comment:1 Changed 4 years ago by karsten

Server descriptors is indeed the commonly used name for documents published by relays (and bridges) to advertise themselves in the network, among other things. That's also the term I use everywhere.

Router descriptors in dir-spec is probably a term back from the time when clients were called onion proxies and relays were called onion routers. Should be safe to rename router descriptors to server descriptors in dir-spec, though I haven't looked.

Relay descriptors as used by CollecTor is not the same as server descriptors, because it comprises extra-info descriptors and even consensuses, votes, and other documents published by the directory authorities. That's to distinguish them from bridge descriptors, which includes server descriptors, extra-info descriptors, and network statuses. We can't rename relay descriptors in CollecTor to server descriptors.

comment:2 Changed 4 years ago by atagar

Sounds good! I'll poke Nick with a little patch to s/router descriptor/server descriptor tomorrow.

comment:3 Changed 4 years ago by atagar

Status: newneeds_review

Change in my 14987 branch - Nick, mind a peek?

https://gitweb.torproject.org/user/atagar/torspec.git/commit/?h=14987

comment:4 Changed 4 years ago by nickm

Milestone: Tor: 0.2.7.x-final

ack on changing this in *-spec.txt; but I'm not so sure about changing all the proposals. I feel like old proposals are *not* living documents, and should probably get left alone.

comment:5 Changed 4 years ago by atagar

Ok. Pushed a change that doesn't include the proposals to my 14987b branch...

https://gitweb.torproject.org/user/atagar/torspec.git/commit/?h=14987b

comment:6 Changed 4 years ago by nickm

Merged to torspec.

comment:7 Changed 4 years ago by nickm

Owner: changed from atagar to nickm
Status: needs_reviewaccepted

We should also do a replacement in the tor code and documentation. I've updated the manpage. I won't update old changelog entries. Updating the code is potentially nontrivial, since search-and-replace needs careful examination. I think in any case this should wait till after a merge of #12498, since that patch updates the serverdesc code a lot.

comment:8 Changed 4 years ago by nickm

Keywords: 027-triaged-1-out added

Marking triaged-out items from first round of 0.2.7 triage.

comment:9 Changed 4 years ago by nickm

Milestone: Tor: 0.2.7.x-finalTor: 0.2.???

Make all non-needs_review, non-needs_revision, 027-triaged-1-out items belong to 0.2.???

comment:10 Changed 2 years ago by teor

Milestone: Tor: 0.2.???Tor: 0.3.???

Milestone renamed

comment:11 Changed 2 years ago by nickm

Keywords: tor-03-unspecified-201612 added
Milestone: Tor: 0.3.???Tor: unspecified

Finally admitting that 0.3.??? was a euphemism for Tor: unspecified all along.

comment:12 Changed 20 months ago by nickm

Keywords: tor-03-unspecified-201612 removed

Remove an old triaging keyword.

comment:13 Changed 20 months ago by nickm

Keywords: 027-triaged-in added

comment:14 Changed 20 months ago by nickm

Keywords: 027-triaged-in removed

comment:15 Changed 20 months ago by nickm

Keywords: 027-triaged-1-out removed

comment:16 Changed 20 months ago by nickm

Milestone: Tor: unspecifiedTor: 0.3.1.x-final
Severity: Normal
Status: acceptedneeds_review

comment:17 Changed 19 months ago by nickm

Milestone: Tor: 0.3.1.x-finalTor: unspecified
Status: needs_reviewnew

Whoops; this should not have been needs_review, since i merged damian's patch a couple of years ago.

Note: See TracTickets for help on using tickets.