[tor-commits] [chutney/master] Add documentation comments for some chutney internal options

[teor@xxxxxxxxxxxxxx]

commit 762bb838ac5383c61bada5eebeeeda631a17ea3a
Author: teor <teor2345@xxxxxxxxx>
Date:   Mon Apr 10 13:17:52 2017 +1000

    Add documentation comments for some chutney internal options
---
 lib/chutney/TorNet.py | 44 +++++++++++++++++++++++++-------------------
 1 file changed, 25 insertions(+), 19 deletions(-)

diff --git a/lib/chutney/TorNet.py b/lib/chutney/TorNet.py
index e61e425..5032c2b 100644
--- a/lib/chutney/TorNet.py
+++ b/lib/chutney/TorNet.py
@@ -702,6 +702,7 @@ class LocalNodeController(NodeController):
                     self._env['poll_launch_time_default']
             return False
 
+# XXX: document these options
 DEFAULTS = {
     'authority': False,
     'bridgeauthority': False,
@@ -761,27 +762,32 @@ class TorEnviron(chutney.Templating.Environ):
 
        Environment fields provided:
 
-          orport, controlport, socksport, dirport:
-          dir:
-          nick:
-          tor_gencert:
-          auth_passphrase:
-          torrc_template_path:
-          hs_hostname:
+          orport, controlport, socksport, dirport: *Port torrc option
+          dir: DataDirectory torrc option
+          nick: Nickname torrc option
+          tor_gencert: name or path of the tor-gencert binary
+          auth_passphrase: obsoleted by CookieAuthentication
+          torrc_template_path: path to chutney torrc_templates directory
+          hs_hostname: the hostname of the key generated by a hidden service
+          owning_controller_process: the __OwningControllerProcess torrc line,
+             or an empty string if tor should continue after the script exits
 
        Environment fields used:
-          nodenum
-          tag
-          orport_base, controlport_base, socksport_base, dirport_base
-          tor-gencert (note hyphen)
-          chutney_dir
-          tor
-          dir
-          hs_directory
-          nick (debugging only)
-          hs-hostname (note hyphen)
-
-       XXXX document the above.  Or document all fields in one place?
+          nodenum: chutney's internal node number for the node
+          tag: a short text string that represents the type of node
+          orport_base, controlport_base, socksport_base, dirport_base: the
+             initial port numbers used by nodenum 0. Each additional node adds
+             1 to the port numbers.
+          tor-gencert (note hyphen): name or path of the tor-gencert binary (if
+             present)
+          chutney_dir: directory of the chutney source code
+          tor: name or path of the tor binary
+          net_base_dir: path to the chutney net directory
+          hs_directory: name of the hidden service directory
+          nick: Nickname torrc option (debugging only)
+          hs-hostname (note hyphen): cached hidden service hostname value
+          controlling_pid: the PID of the controlling process. After this
+             process exits, the child tor processes will exit
     """
 
     def __init__(self, parent=None, **kwargs):



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