diff options
| author | Bartosz Duszel <bartosz.duszel@protonmail.com> | 2020-03-26 16:19:42 +0100 |
|---|---|---|
| committer | Bartosz Duszel <bartosz.duszel@protonmail.com> | 2020-03-26 16:19:42 +0100 |
| commit | b210aefb7fd22e49077f7be6ef481ca0bf20d2bb (patch) | |
| tree | f349bb124418a45747e958bb86fbd8d25308799d /doc/HACKING/Module.md | |
| parent | af4b5eba34f372376d78abc261e7043467e15613 (diff) | |
| download | tor-b210aefb7fd22e49077f7be6ef481ca0bf20d2bb.tar.gz tor-b210aefb7fd22e49077f7be6ef481ca0bf20d2bb.zip | |
doc: Replace "underline" with "## Section name".
This approach doesn't require variable-length underlines.
Diffstat (limited to 'doc/HACKING/Module.md')
| -rw-r--r-- | doc/HACKING/Module.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/HACKING/Module.md b/doc/HACKING/Module.md index 781bb978f2..f8a9773d47 100644 --- a/doc/HACKING/Module.md +++ b/doc/HACKING/Module.md @@ -1,9 +1,9 @@ -# Modules in Tor # +# Modules in Tor This document describes the build system and coding standards when writing a module in Tor. -## What is a module? ## +## What is a module? In the context of the tor code base, a module is a subsystem that we can selectively enable or disable, at `configure` time. @@ -27,7 +27,7 @@ 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. -## Build System ## +## Build System The changes to the build system are pretty straightforward. @@ -55,7 +55,7 @@ Finally, your module will automatically be included in the `TOR_MODULES_ALL_ENABLED` variable which is used to build the unit tests. They always build everything in order to test everything. -## Coding ## +## Coding As mentioned above, a module should be isolated in its own directories, suffixed with the name of the module, in `src/*/`. |