From c03fe62b195974526154be8ec96061da58109fdb Mon Sep 17 00:00:00 2001
From: Andrea Spadaccini <spadaccio@google.com>
Date: Mon, 19 Sep 2011 14:32:34 +0100
Subject: [PATCH] Fix backend.MigrateInstance docs
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
The MigrateInstance function does not return anything, so the relevant
lines are removed from the documentation. Instead, the raised exception
is documented.
Signed-off-by: Andrea Spadaccini <spadaccio@google.com>
Reviewed-by: RenΓ© Nussbaumer <rn@google.com>
---
lib/backend.py | 5 +----
1 file changed, 1 insertion(+), 4 deletions(-)
diff --git a/lib/backend.py b/lib/backend.py
index 36da855cc..4e7154608 100644
--- a/lib/backend.py
+++ b/lib/backend.py
@@ -1304,10 +1304,7 @@ def MigrateInstance(instance, target, live):
@type live: boolean
@param live: whether the migration should be done live or not (the
interpretation of this parameter is left to the hypervisor)
- @rtype: tuple
- @return: a tuple of (success, msg) where:
- - succes is a boolean denoting the success/failure of the operation
- - msg is a string with details in case of failure
+ @raise RPCFail: if migration fails for some reason
"""
hyper = hypervisor.GetHypervisor(instance.hypervisor)
--
GitLab