Commit fdf7f055 authored by Guido Trotter's avatar Guido Trotter
Browse files

Xen: use epydoc in MigrateInstance docstring

Reviewed-by: iustinp
parent 920aae98
...@@ -269,16 +269,16 @@ class XenHypervisor(hv_base.BaseHypervisor): ...@@ -269,16 +269,16 @@ class XenHypervisor(hv_base.BaseHypervisor):
def MigrateInstance(self, instance, target, live): def MigrateInstance(self, instance, target, live):
"""Migrate an instance to a target node. """Migrate an instance to a target node.
Arguments:
- instance: the name of the instance
- target: the ip of the target node
- live: whether to do live migration or not
Returns: none, errors will be signaled by exception.
The migration will not be attempted if the instance is not The migration will not be attempted if the instance is not
currently running. currently running.
@type instance: string
@param instance: instance name
@type target: string
@param target: ip address of the target node
@type live: boolean
@param live: perform a live migration
""" """
if self.GetInstanceInfo(instance) is None: if self.GetInstanceInfo(instance) is None:
raise errors.HypervisorError("Instance not running, cannot migrate") raise errors.HypervisorError("Instance not running, cannot migrate")
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment