[tor-commits] [chutney/main] Document some issues around arti config.

[nickm at torproject.org]

commit 78f4bd03c3c236bd3932e24a0236ea2fa64387b5
Author: Nick Mathewson <nickm at torproject.org>
Date:   Mon Sep 27 08:49:44 2021 -0400

    Document some issues around arti config.
---
 lib/chutney/TorNet.py | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/lib/chutney/TorNet.py b/lib/chutney/TorNet.py
index 873681d..ce3873a 100644
--- a/lib/chutney/TorNet.py
+++ b/lib/chutney/TorNet.py
@@ -791,9 +791,17 @@ class LocalNodeBuilder(NodeBuilder):
             self._env['fingerprint_ed25519'] = ""
 
     def _getAltAuthLines(self, hasbridgeauth=False):
-        """Return a combination of AlternateDirAuthority,
-        and AlternateBridgeAuthority lines for
-        this Node, appropriately.  Non-authorities return ""."""
+        """Return a set of lines to configure other nodes to use this Node as
+        an authority.  For C tor, this is a combination of
+        AternateDirAuthority and AlternateBridgeAuthority.  For Arti,
+        this is a pair of lines to use this node as an authority and
+        as a fallback.  (Arti does not automatically use authorities
+        as fallbacks.)
+
+        The answers are returned as: (tor-auth, (arti-auth, arti-fallback))
+
+        If this node not an authority, the returned strings are empty.
+        """
         if not self._env['authority']:
             return ("",("", ""))
 
@@ -2357,6 +2365,9 @@ cache_dir = "{path}/arti/cache"
 state_dir = "{path}/arti/state"
 
 [path_rules]
+# These values disable enforce_distance entirely; we can replace them
+# with something like Tor's "EnforceDistinceSubnets 0" if Arti ever
+# implements it.
 enforce_distance = {{ "subnets_family_v4" = 33, "subnets_family_v6" = 129 }}
 
 """.format(path=self.dir))