diff options
| author | Nick Mathewson <nickm@torproject.org> | 2020-06-26 10:11:42 -0400 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2020-06-26 10:11:42 -0400 |
| commit | 5336ac26693cdba47422771ea951d22a290f67df (patch) | |
| tree | e37f37242d80146ee55651ba2c90b0bb80e0c3d9 /src | |
| parent | e269e081a1c1ec3450e8b86f64aa099f51b04b84 (diff) | |
| download | tor-5336ac26693cdba47422771ea951d22a290f67df.tar.gz tor-5336ac26693cdba47422771ea951d22a290f67df.zip | |
Move remaining CodeStructure.md contents into doxygen.
Diffstat (limited to 'src')
| -rw-r--r-- | src/app/app.md | 5 | ||||
| -rw-r--r-- | src/feature/feature.md | 23 |
2 files changed, 28 insertions, 0 deletions
diff --git a/src/app/app.md b/src/app/app.md index 138e75b127..298bde75f5 100644 --- a/src/app/app.md +++ b/src/app/app.md @@ -4,3 +4,8 @@ The "app" directory has Tor's main entry point and configuration logic, and is responsible for initializing and managing the other modules in Tor. + +The modules in "app" are: + + - \refdir{app/config} -- configuration and state for Tor + - \refdir{app/main} -- Top-level functions to invoke the rest or Tor. diff --git a/src/feature/feature.md b/src/feature/feature.md index acc3487e55..d9f7bd5c0e 100644 --- a/src/feature/feature.md +++ b/src/feature/feature.md @@ -5,3 +5,26 @@ The "feature" directory has modules that Tor uses only for a particular role or service, such as maintaining/using an onion service, operating as a relay or a client, or being a directory authority. +Current subdirectories are: + + - \refdir{feature/api} -- Support for making Tor embeddable + - \refdir{feature/client} -- Functionality which only Tor clients need + - \refdir{feature/control} -- Controller implementation + - \refdir{feature/dirauth} -- Directory authority + - \refdir{feature/dircache} -- Directory cache + - \refdir{feature/dirclient} -- Directory client + - \refdir{feature/dircommon} -- Shared code between the other directory modules + - \refdir{feature/dirparse} -- Directory parsing code. + - \refdir{feature/hibernate} -- Hibernating when Tor is out of bandwidth + or shutting down + - \refdir{feature/hs} -- v3 onion service implementation + - \refdir{feature/hs_common} -- shared code between both onion service + implementations + - \refdir{feature/keymgt} -- shared code for key management between + relays and onion services. + - \refdir{feature/nodelist} -- storing and accessing the list of relays on + the network. + - \refdir{feature/relay} -- code that only relay servers and exit servers + need. + - \refdir{feature/rend} -- v2 onion service implementation + - \refdir{feature/stats} -- statistics and history |