[tor-commits] [tor/master] Document test_keygen.sh a little more

[nickm at torproject.org]

commit 5d76acfcb302619dd97f6f2519889752bfa60e2e
Author: Nick Mathewson <nickm at torproject.org>
Date:   Thu Aug 6 11:58:50 2015 -0400

    Document test_keygen.sh a little more
---
 src/test/test_keygen.sh |    7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/test/test_keygen.sh b/src/test/test_keygen.sh
index 1005bb8..565e0a4 100755
--- a/src/test/test_keygen.sh
+++ b/src/test/test_keygen.sh
@@ -69,6 +69,13 @@ touch "${DATA_DIR}/empty_torrc"
 QUIETLY="--hush"
 TOR="${TOR_BINARY} ${QUIETLY} --DisableNetwork 1 --ShutdownWaitLength 0 --ORPort 12345 --ExitRelay 0 -f ${DATA_DIR}/empty_torrc"
 
+##### SETUP
+#
+# Here we create three sets of keys: one using "tor", one using "tor
+# --keygen", and one using "tor --keygen" and encryption.  We'll be
+# copying them into different keys directories in order to simulate
+# different kinds of configuration problems/issues.
+
 # Step 1: Start Tor with --list-fingerprint.  Make sure everything is there.
 mkdir "${DATA_DIR}/orig"
 ${TOR} --DataDirectory "${DATA_DIR}/orig" --list-fingerprint > /dev/null