diff options
| author | Nick Mathewson <nickm@torproject.org> | 2020-01-08 21:03:20 -0500 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2020-01-16 07:48:17 -0500 |
| commit | 888a0be0b913bea33d9b2ba635b7f27db5fc1b95 (patch) | |
| tree | 6e3a1d7dad23420bd228831cf812762baad84967 /doc/HACKING | |
| parent | a48cb9fa436720c263dd41ce501076185aeb5872 (diff) | |
| download | tor-888a0be0b913bea33d9b2ba635b7f27db5fc1b95.tar.gz tor-888a0be0b913bea33d9b2ba635b7f27db5fc1b95.zip | |
Define a "dircache" module.
For now, this module is enabled whenever the relay module is
enabled, and disabled whenever the relay module is disabled. Though
they are logically separate, the use cases for running one without
the other are rare enough that we don't really want to support
compiling them independently.
Diffstat (limited to 'doc/HACKING')
| -rw-r--r-- | doc/HACKING/Module.md | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/HACKING/Module.md b/doc/HACKING/Module.md index 3a07d0c639..781bb978f2 100644 --- a/doc/HACKING/Module.md +++ b/doc/HACKING/Module.md @@ -11,12 +11,18 @@ selectively enable or disable, at `configure` time. Currently, tor has these modules: - Relay subsystem (relay) + - Directory cache system (dircache). - Directory Authority subsystem (dirauth) -dirauth is located in its own directory in `src/feature/dirauth/`. +The dirauth code is located in its own directory in `src/feature/dirauth/`. -Relay is located in directories named `src/*/*relay` and `src/*/*dircache`, -which are being progressively refactored and disabled. +The relay code is located in a directory named `src/*/*relay`, which is +being progressively refactored and disabled. + +The dircache code is located in `src/*/*dircache`. Right now, it is +disabled if and only if the relay module is disabled. (We are treating +them as separate modules because they are logically independent, not +because you would actually want to run one without the other.) To disable a module, pass `--disable-module-{dirauth,relay}` at configure time. All modules are currently enabled by default. |