[tor-commits] [tor/maint-0.2.8] Improve comments in fallback update script

[nickm at torproject.org]

commit 46d813922ab891d934fca02d5511b7fbe18ebda8
Author: teor (Tim Wilson-Brown) <teor2345 at gmail.com>
Date:   Fri Apr 29 11:43:55 2016 +1000

    Improve comments in fallback update script
---
 scripts/maint/updateFallbackDirs.py | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/scripts/maint/updateFallbackDirs.py b/scripts/maint/updateFallbackDirs.py
index d27c144..7e882a8 100755
--- a/scripts/maint/updateFallbackDirs.py
+++ b/scripts/maint/updateFallbackDirs.py
@@ -1,6 +1,13 @@
 #!/usr/bin/python
 
 # Usage: scripts/maint/updateFallbackDirs.py > src/or/fallback_dirs.inc
+#
+# This script should be run from a stable, reliable network connection,
+# with no other network activity (and not over tor).
+# If this is not possible, please disable:
+# PERFORM_IPV4_DIRPORT_CHECKS and PERFORM_IPV6_DIRPORT_CHECKS
+#
+# Needs dateutil (and potentially other python packages)
 # Needs stem available in your PYTHONPATH, or just ln -s ../stem/stem .
 # Optionally uses ipaddress (python 3 builtin) or py2-ipaddress (package)
 # for netblock analysis, in PYTHONPATH, or just
@@ -1061,7 +1068,7 @@ class Candidate(object):
     downloader = DescriptorDownloader()
     start = datetime.datetime.utcnow()
     # some directory mirrors respond to requests in ways that hang python
-    # sockets, which is why we long this line here
+    # sockets, which is why we log this line here
     logging.info('Initiating consensus download from %s (%s:%d).', nickname,
                  dirip, dirport)
     # there appears to be about 1 second of overhead when comparing stem's