[tor-commits] [tor/master] Mention that src/ext should not be edited lightly.

[dgoulet@xxxxxxxxxxxxxx]

commit fbf8bda30b7d522f079544eb35b0952f2832cd52
Author: Nick Mathewson <nickm@xxxxxxxxxxxxxx>
Date:   Thu Jul 2 13:38:13 2020 -0400

    Mention that src/ext should not be edited lightly.
    
    Closes #32661
---
 src/ext/README  | 7 +++++++
 src/mainpage.md | 3 ++-
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/src/ext/README b/src/ext/README
index d7e5439c7..a5ed747ad 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 2c4c49435..260e193f1 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.



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits