summaryrefslogtreecommitdiff
path: root/distbuild
diff options
context:
space:
mode:
authorSam Thursfield <sam.thursfield@codethink.co.uk>2014-04-09 13:55:32 +0000
committerSam Thursfield <sam.thursfield@codethink.co.uk>2014-04-14 11:19:06 +0300
commit5636a47c71bb063f351583a98064892f225f9be4 (patch)
treece7560821345aafc3fae6ac83efb629f2f3c9054 /distbuild
parent7b78e37eae3d9a570175ca6c824a3af6c0802b83 (diff)
downloadmorph-5636a47c71bb063f351583a98064892f225f9be4.tar.gz
distbuild: Clarify InitiatorConnection docstring
Diffstat (limited to 'distbuild')
-rw-r--r--distbuild/initiator_connection.py9
1 files changed, 6 insertions, 3 deletions
diff --git a/distbuild/initiator_connection.py b/distbuild/initiator_connection.py
index bdce55e4..31f89479 100644
--- a/distbuild/initiator_connection.py
+++ b/distbuild/initiator_connection.py
@@ -35,9 +35,12 @@ class _Close(object):
class InitiatorConnection(distbuild.StateMachine):
- '''Communicate with the initiator.
-
- This state machine communicates with the initiator, relaying and
+ '''Communicate with a single initiator.
+
+ When a developer runs 'morph distbuild' and connects to the controller,
+ the ListenServer object on the controller creates an InitiatorConnection.
+
+ This state machine communicates with the build initiator, relaying and
translating messages from the initiator to the rest of the controller's
state machines, and vice versa.