From 62753921761d8b0cdf8d07b9c8c040df50e759dd Mon Sep 17 00:00:00 2001
From: Anton Beloglazov <anton.beloglazov@gmail.com>
Date: Thu, 20 Sep 2012 11:42:11 +1000
Subject: [PATCH] Updated the commments

---
 neat/globals/manager.py | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

diff --git a/neat/globals/manager.py b/neat/globals/manager.py
index 4b6e614..beff07a 100644
--- a/neat/globals/manager.py
+++ b/neat/globals/manager.py
@@ -193,13 +193,10 @@ def init_state(config):
 
 @contract
 def execute_underload(config, state, host):
-    """ Execute an iteration of the global manager
+    """ Process an underloaded host: migrate all VMs from the host.
 
-1. Parse the `vm_uuids` parameter and transform it into a list of
-   UUIDs of the VMs to migrate.
-
-2. Call the Nova API to obtain the current placement of VMs on the
-   hosts.
+1. Call the nova API to obtain the UUIDs of the VMs allocated to the
+   host.
 
 3. Call the function specified in the `algorithm_vm_placement_factory`
    configuration option and pass the UUIDs of the VMs to migrate and
@@ -208,12 +205,17 @@ def execute_underload(config, state, host):
 4. Call the Nova API to migrate the VMs according to the placement
    determined by the `algorithm_vm_placement_factory` algorithm.
 
+5. Switch off the host at the end of the VM migration.
+
     :param config: A config dictionary.
      :type config: dict(str: *)
 
     :param state: A state dictionary.
      :type state: dict(str: *)
 
+    :param state: A host name.
+     :type state: str
+
     :return: The updated state dictionary.
      :rtype: dict(str: *)
     """
@@ -224,10 +226,7 @@ def execute_underload(config, state, host):
 def execute_overload(config, state, vm_uuids):
     """ Execute an iteration of the global manager
 
-1. Parse the `vm_uuids` parameter and transform it into a list of
-   UUIDs of the VMs to migrate.
-
-2. Call the Nova API to obtain the current placement of VMs on the
+1. Call the Nova API to obtain the current placement of VMs on the
    hosts.
 
 3. Call the function specified in the `algorithm_vm_placement_factory`
@@ -243,6 +242,9 @@ def execute_overload(config, state, vm_uuids):
     :param state: A state dictionary.
      :type state: dict(str: *)
 
+    :param vm_uuids: A list of VM UUIDs to migrate from the host.
+     :type vm_uuids: list(str)
+
     :return: The updated state dictionary.
      :rtype: dict(str: *)
     """