Opened 7 weeks ago

Closed 4 days ago

#31852 closed defect (wontfix)

Rename doc/HACKING/design members to reflect current architectural division

Reported by: nickm Owned by: nickm
Priority: Medium Milestone: Tor: 0.4.3.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: network-team-roadmap-november, s31-docs
Cc: nickm, catalyst Actual Points:
Parent ID: #29214 Points:
Reviewer: teor Sponsor:

Description

The original tor-guts.git document pre-dated the source code re-organization when we divided things into src/lib/*, src/core/*, src/feature/*, and src/app/*.

We'll want to edit the documentation to correspond to reality. But before we do that, we'll want to rename and divide the modules so that they have the right names. (Git handles edits better if there are no edit/split/move conflicts.)

Child Tickets

Change History (5)

comment:1 Changed 7 weeks ago by nickm

I think we have the following general headings:

  • Overview
  • Parts of the code
    • Lib
    • Core
    • Features
    • App
  • Data-flow discussion
  • ... ?

comment:2 Changed 7 weeks ago by teor

I'd like a discussion of data flow and event flow.
And something about how we test (if that belongs here).
What's remaining after that?

Eventually, I'd like an explanation of config and control and how they are split between modules. (But that might be our target design.)

comment:3 Changed 4 weeks ago by nickm

I'm going to defer action on the final filenames here, and plan to rename things a lot as I go along. I don't think I can get a final organization any time soon.

comment:4 Changed 9 days ago by catalyst

Cc: catalyst added

comment:5 Changed 4 days ago by nickm

Resolution: wontfix
Status: assignedclosed

Instead of taking this route, we are reintegrating the contents of doc/HACKING/design into our doxygen.

Note: See TracTickets for help on using tickets.