Adds return-type in two functions' docstrings

Change-Id: Ifdf49c59d8e983905ad6f31e0a3f7f64cd5a297c
Fixes: bug #1130922

3 files changed, 10 insertions, 6 deletions

diff --git a/nova/compute/manager.py b/nova/compute/manager.py
index 604362783..6cd688e83 100755
--- a/nova/compute/manager.py
+++ b/nova/compute/manager.py
@@ -2995,9 +2995,7 @@ class ComputeManager(manager.SchedulerDependentManager):
         :param instance: dict of instance data
         :param block_migration: if true, prepare for block migration
         :param disk_over_commit: if true, allow disk over commit
-
-        Returns a mapping of values required in case of block migration
-        and None otherwise.
+        :returns: a dict containing migration info
         """
         src_compute_info = self._get_compute_info(ctxt, instance['host'])
         dst_compute_info = self._get_compute_info(ctxt, CONF.host)
@@ -3026,9 +3024,7 @@ class ComputeManager(manager.SchedulerDependentManager):
         :param context: security context
         :param instance: dict of instance data
         :param dest_check_data: result of check_can_live_migrate_destination
-
-        Returns a dict values required for live migration without shared
-        storage.
+        :returns: a dict containing migration info
         """
         capi = self.conductor_api
         bdms = capi.block_device_mapping_get_all_by_instance(ctxt, instance)
diff --git a/nova/virt/driver.py b/nova/virt/driver.py
index 71bcaef42..827a2b782 100755
--- a/nova/virt/driver.py
+++ b/nova/virt/driver.py
@@ -502,6 +502,7 @@ class ComputeDriver(object):
         :param dst_compute_info: Info about the receiving machine
         :param block_migration: if true, prepare for block migration
         :param disk_over_commit: if true, allow disk over commit
+        :returns: a dict containing migration info (hypervisor-dependent)
         """
         raise NotImplementedError()
 
@@ -524,6 +525,7 @@ class ComputeDriver(object):
         :param context: security context
         :param instance_ref: nova.db.sqlalchemy.models.Instance
         :param dest_check_data: result of check_can_live_migrate_destination
+        :returns: a dict containing migration info (hypervisor-dependent)
         """
         raise NotImplementedError()
 
diff --git a/nova/virt/libvirt/driver.py b/nova/virt/libvirt/driver.py
index c5692929c..498ef1d82 100755
--- a/nova/virt/libvirt/driver.py
+++ b/nova/virt/libvirt/driver.py
@@ -2833,6 +2833,11 @@ class LibvirtDriver(driver.ComputeDriver):
         :param instance_ref: nova.db.sqlalchemy.models.Instance
         :param block_migration: if true, prepare for block migration
         :param disk_over_commit: if true, allow disk over commit
+        :returns: a dict containing:
+             :filename: name of the tmpfile under CONF.instances_path
+             :block_migration: whether this is block migration
+             :disk_over_commit: disk-over-commit factor on dest host
+             :disk_available_mb: available disk space on dest host
         """
         disk_available_mb = None
         if block_migration:
@@ -2872,6 +2877,7 @@ class LibvirtDriver(driver.ComputeDriver):
         :param context: security context
         :param instance_ref: nova.db.sqlalchemy.models.Instance
         :param dest_check_data: result of check_can_live_migrate_destination
+        :returns: a dict containing migration info
         """
         # Checking shared storage connectivity
         # if block migration, instances_paths should not be on shared storage.