Expand description for TargetStartupMonitor
authorFrancisco Redondo Marchena <francisco.marchena@codethink.co.uk>
Thu, 9 Aug 2012 15:34:11 +0000 (16:34 +0100)
committerFrancisco Redondo Marchena <francisco.marchena@codethink.co.uk>
Fri, 10 Aug 2012 09:12:38 +0000 (10:12 +0100)
node-startup-controller/target-startup-monitor.c

index 1b5db78..dd93873 100644 (file)
  * 
  * The #TargetStartupMonitor class is responsible for setting the state of the
  * Node State Manager using states from #NSMNodeState. It sets the node state
- * under the following circumstances:
+ * under the following circumstances:
  * 
- * The Node Startup Controller is starting up. In the GENIVI lifecycle subsystem,
- * this means that all mandatory applications have been started - set the state to
- * %NSM_NODE_STATE_BASE_RUNNING.
+ * 1. The Node Startup Controller is starting up. In the GENIVI lifecycle subsystem,
+ *    this means that all mandatory applications have been started - set the state to
+ *    %NSM_NODE_STATE_BASE_RUNNING.
  * 
- * The systemd unit %focussed.target has started - set the state to
- * %NSM_NODE_STATE_LUC_RUNNING.
+ * 2. The #TargetStartupMonitor receives a "JobRemoved" signal from "focussed.target",
+ *    "unfocussed.target" or "lazy.target" indicating that this unit has changed its
+ *     active state to "active" then:
+ *
+ *     - If the systemd unit "focussed.target" has started - set the state to
+ *       %NSM_NODE_STATE_LUC_RUNNING.
  * 
- * The systemd unit %unfocussed.target has started - set the state to
- * %NSM_NODE_STATE_FULLY_RUNNING.
+ *     - If the systemd unit "unfocussed.target" has started - set the state to
+ *       %NSM_NODE_STATE_FULLY_RUNNING.
  * 
- * The systemd unit %lazy.target has started - set the state to
- * %NSM_NODE_STATE_FULLY_OPERATIONAL.
+ *     - If the systemd unit "lazy.target" has started - set the state to
+ *       %NSM_NODE_STATE_FULLY_OPERATIONAL.
  */