From fdf7f055b2dc434c3401975612ec6f3e9e5a92b7 Mon Sep 17 00:00:00 2001
From: Guido Trotter <ultrotter@google.com>
Date: Tue, 20 Jan 2009 18:11:35 +0000
Subject: [PATCH] Xen: use epydoc in MigrateInstance docstring
Reviewed-by: iustinp
---
lib/hypervisor/hv_xen.py | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/lib/hypervisor/hv_xen.py b/lib/hypervisor/hv_xen.py
index 0aa956032..6da7f1a2b 100644
--- a/lib/hypervisor/hv_xen.py
+++ b/lib/hypervisor/hv_xen.py
@@ -269,16 +269,16 @@ class XenHypervisor(hv_base.BaseHypervisor):
def MigrateInstance(self, instance, target, live):
"""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
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:
raise errors.HypervisorError("Instance not running, cannot migrate")
--
GitLab