diff options
| author | Nick Mathewson <nickm@torproject.org> | 2020-07-02 13:38:13 -0400 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2020-07-02 13:38:17 -0400 |
| commit | fbf8bda30b7d522f079544eb35b0952f2832cd52 (patch) | |
| tree | 94d2a2addc1ca777a1487201bb6f832d27f13b9b /src | |
| parent | a34b9a0b6258d0f1d9373fcf7aacf1e30f8efd37 (diff) | |
| download | tor-fbf8bda30b7d522f079544eb35b0952f2832cd52.tar.gz tor-fbf8bda30b7d522f079544eb35b0952f2832cd52.zip | |
Mention that src/ext should not be edited lightly.
Closes #32661
Diffstat (limited to 'src')
| -rw-r--r-- | src/ext/README | 7 | ||||
| -rw-r--r-- | src/mainpage.md | 3 |
2 files changed, 9 insertions, 1 deletions
diff --git a/src/ext/README b/src/ext/README index d7e5439c71..a5ed747ad7 100644 --- a/src/ext/README +++ b/src/ext/README @@ -1,3 +1,10 @@ +This directory holds code that was written elsewhere, and is not +reliably packaged as a library where we want to build, so we ship +it along with Tor. + +In general, you should not edit this code: we are not the maintainers. +Instead, you should submit patches upstream. + OpenBSD_malloc_Linux.c: diff --git a/src/mainpage.md b/src/mainpage.md index 2c4c494354..260e193f1c 100644 --- a/src/mainpage.md +++ b/src/mainpage.md @@ -84,7 +84,8 @@ The codebase is divided into a few top-level subdirectories, each of which contains several sub-modules. - `ext` -- Code maintained elsewhere that we include in the Tor - source distribution. + source distribution. You should not edit this code if you can + avoid it: we try to keep it identical to the upstream versions. - \refdir{lib} -- Lower-level utility code, not necessarily tor-specific. |