distbuild: Label state machine transition tables

Makes it easier to see what they mean at a glance.

10 files changed, 11 insertions, 0 deletions

diff --git a/distbuild/build_controller.py b/distbuild/build_controller.py
index 3160364a..d731c497 100644
--- a/distbuild/build_controller.py
+++ b/distbuild/build_controller.py
@@ -168,6 +168,7 @@ class BuildController(distbuild.StateMachine):
         distbuild.crash_point()
 
         spec = [
+            # state, source, event_class, new_state, callback
             ('init', self, _Start, 'graphing', self._start_graphing),
             ('init', distbuild.InitiatorConnection,
                 distbuild.InitiatorDisconnect, 'init', self._maybe_abort),
diff --git a/distbuild/connection_machine.py b/distbuild/connection_machine.py
index 2f768f0b..648ce35a 100644
--- a/distbuild/connection_machine.py
+++ b/distbuild/connection_machine.py
@@ -81,6 +81,7 @@ class ConnectionMachine(distbuild.StateMachine):
         self.mainloop.add_event_source(self._timer)
 
         spec = [
+            # state, source, event_class, new_state, callback
             ('connecting', self._sock_proxy, distbuild.SocketWriteable, 
                 'connected', self._connect),
             ('connecting', self, StopConnecting, None, self._stop),
diff --git a/distbuild/helper_router.py b/distbuild/helper_router.py
index 752a5fdb..1f0ce45b 100644
--- a/distbuild/helper_router.py
+++ b/distbuild/helper_router.py
@@ -82,6 +82,7 @@ class HelperRouter(distbuild.StateMachine):
         self.mainloop.add_state_machine(jm)
         
         spec = [
+            # state, source, event_class, new_state, callback
             ('idle', HelperRouter, HelperRequest, 'idle', 
                 self._handle_request),
             ('idle', jm, distbuild.JsonNewMessage, 'idle', self._helper_msg),
diff --git a/distbuild/initiator.py b/distbuild/initiator.py
index 069578d2..6e4ca65a 100644
--- a/distbuild/initiator.py
+++ b/distbuild/initiator.py
@@ -58,6 +58,7 @@ class Initiator(distbuild.StateMachine):
         logging.debug('initiator: _jm=%s' % repr(self._jm))
         
         spec = [
+            # state, source, event_class, new_state, callback
             ('waiting', self._jm, distbuild.JsonEof, None, self._terminate),
             ('waiting', self._jm, distbuild.JsonNewMessage, 'waiting',
                 self._handle_json_message),
diff --git a/distbuild/initiator_connection.py b/distbuild/initiator_connection.py
index d48d4698..bdce55e4 100644
--- a/distbuild/initiator_connection.py
+++ b/distbuild/initiator_connection.py
@@ -64,6 +64,7 @@ class InitiatorConnection(distbuild.StateMachine):
         self.our_ids = set()
         
         spec = [
+            # state, source, event_class, new_state, callback
             ('idle', self.jm, distbuild.JsonNewMessage, 'idle', 
                 self._handle_msg),
             ('idle', self.jm, distbuild.JsonEof, 'closing', self._disconnect),
diff --git a/distbuild/jm.py b/distbuild/jm.py
index bb86adc4..a4e366a7 100644
--- a/distbuild/jm.py
+++ b/distbuild/jm.py
@@ -56,6 +56,7 @@ class JsonMachine(StateMachine):
         self.receive_buf = StringBuffer()
 
         spec = [
+            # state, source, event_class, new_state, callback
             ('rw', sockbuf, SocketBufferNewData, 'rw', self._parse),
             ('rw', sockbuf, SocketBufferEof, 'w', self._send_eof),
             ('rw', self, _Close2, None, self._really_close),
diff --git a/distbuild/json_router.py b/distbuild/json_router.py
index bf272174..93533b2e 100644
--- a/distbuild/json_router.py
+++ b/distbuild/json_router.py
@@ -52,6 +52,7 @@ class JsonRouter(distbuild.StateMachine):
         self.mainloop.add_state_machine(jm)
         
         spec = [
+            # state, source, event_class, new_state, callback
             ('idle', jm, distbuild.JsonNewMessage, 'idle', self.bloop),
             ('idle', jm, distbuild.JsonEof, None, self.close),
         ]
diff --git a/distbuild/sockbuf.py b/distbuild/sockbuf.py
index 6803bfb5..346706db 100644
--- a/distbuild/sockbuf.py
+++ b/distbuild/sockbuf.py
@@ -89,6 +89,7 @@ class SocketBuffer(StateMachine):
         self._wbuf = StringBuffer()
 
         spec = [
+            # state, source, event_class, new_state, callback
             ('reading', src, SocketReadable, 'reading', self._fill),
             ('reading', self, _WriteBufferNotEmpty, 'rw', 
                 self._start_writing),
diff --git a/distbuild/sockserv.py b/distbuild/sockserv.py
index dc313d06..124d29b9 100644
--- a/distbuild/sockserv.py
+++ b/distbuild/sockserv.py
@@ -26,6 +26,7 @@ class ListenServer(StateMachine):
         self.mainloop.add_event_source(src)
 
         spec = [
+            # state, source, event_class, new_state, callback
             ('listening', src, NewConnection, 'listening', self.new_conn),
             ('listening', src, SocketError, None, self.report_error),
         ]
diff --git a/distbuild/worker_build_scheduler.py b/distbuild/worker_build_scheduler.py
index 5ec7c9aa..9ada07ef 100644
--- a/distbuild/worker_build_scheduler.py
+++ b/distbuild/worker_build_scheduler.py
@@ -127,6 +127,7 @@ class WorkerBuildQueuer(distbuild.StateMachine):
         self._available_workers = []
         
         spec = [
+            # state, source, event_class, new_state, callback
             ('idle', WorkerBuildQueuer, WorkerBuildRequest, 'idle',
                 self._handle_request),
             ('idle', WorkerBuildQueuer, WorkerCancelPending, 'idle',
@@ -210,6 +211,7 @@ class WorkerConnection(distbuild.StateMachine):
         self.mainloop.add_state_machine(self._jm)
         
         spec = [
+            # state, source, event_class, new_state, callback
             ('idle', self._jm, distbuild.JsonEof, None,  self._reconnect),
             ('idle', self, _HaveAJob, 'building', self._start_build),