Opened 6 years ago

Closed 6 years ago

#10645 closed enhancement (fixed)

Re-order dir-spec for readability and maintainability

Reported by: karsten Owned by:
Priority: Medium Milestone:
Component: Core Tor/Tor Version:
Severity: Keywords: tor-spec
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

I'd like to reorder a few things in dir-spec to make it easier to read and easier to extend.

I finished a first revision in my branch reorder-dirspec.

Here are the guidelines that I tried to follow:

  • There's supposed to be one section per role in the directory protocol (client, authority, cache, client) with one subsection per operation performed by this role. If necessary, subsubsections help structure more complex operations.
  • Changes are ordered from the top of the document to the bottom. There's typically one commit (or commit set) for every changed section or subsection.
  • For every change that moves more than a few lines of text, there are typically three commits: the first commit only moves text, the second commit only fixes references, and the third commit edits content.

Child Tickets

Change History (5)

comment:1 Changed 6 years ago by karsten

Status: newneeds_review

comment:2 Changed 6 years ago by nickm

This looks quite good, I've merged it. One more change I want before I close this ticket, though: I would like each section name to be unique. Duplicate names (with counts) are:

   2 Downloading router descriptors
   3 Downloading extra-info documents

comment:3 Changed 6 years ago by nickm

Status: needs_reviewnew

comment:4 Changed 6 years ago by karsten

Status: newneeds_review

How about the changes in my dirspec-uniqsecnames branch?

comment:5 Changed 6 years ago by nickm

Resolution: fixed
Status: needs_reviewclosed

Merged; thanks!

Note: See TracTickets for help on using tickets.