[tor-commits] [chutney/master] TorNet: Improve the function docs of process launch functions

[teor at torproject.org]

commit da1dd8546ba2a8cb37446c23849b0f93aa8a225f
Author: teor <teor at torproject.org>
Date:   Fri Jan 24 11:01:52 2020 +1000

    TorNet: Improve the function docs of process launch functions
    
    Follow up for 33041.
---
 lib/chutney/TorNet.py | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/lib/chutney/TorNet.py b/lib/chutney/TorNet.py
index c94cd8a..1cc1d4e 100644
--- a/lib/chutney/TorNet.py
+++ b/lib/chutney/TorNet.py
@@ -208,8 +208,9 @@ def get_new_absolute_nodes_path(now=time.time()):
     return newdir
 
 def _warnMissingTor(tor_path, cmdline, tor_name="tor"):
-    """Log a warning that the binary tor_name can't be found at tor_path
-       while running cmdline.
+    """Log a warning that the binary canonically named tor_name can't be found
+       at tor_path while running cmdline. Suggest the appropriate
+       environmental variable to set to resolve the issue.
     """
     help_msg_fmt = "Set the '{}' environment variable to the path of '{}'."
     help_msg = ""
@@ -261,8 +262,8 @@ def run_tor(cmdline, exit_on_missing=True):
 
 def launch_process(cmdline, tor_name="tor", stdin=None, exit_on_missing=True):
     """Launch the command line cmdline, which must start with the path or
-       name of a binary. Use tor_name as the canonical name of the binary.
-       Pass stdin to the Popen constructor.
+       name of a binary. Use tor_name as the canonical name of the binary in
+       logs. Pass stdin to the Popen constructor.
 
        Returns the Popen object for the launched process.
     """