[libvirt] [PATCH] doc: Explicitly document migration limitations on errors

Migration of guests that are in error state for example because of I/O errors may not be possible and encountering of such errors may lead to cancellation of such migration. Document this behavior explicitly. --- src/libvirt.c | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/src/libvirt.c b/src/libvirt.c index 620dbdd..1bdd193 100644 --- a/src/libvirt.c +++ b/src/libvirt.c @@ -5196,7 +5196,10 @@ virDomainMigrateDirect(virDomainPtr domain, * There are many limitations on migration imposed by the underlying * technology - for example it may not be possible to migrate between * different processors even with the same architecture, or between - * different types of hypervisor. + * different types of hypervisor. A domain may not be migratable + * because of configuration or error states. A domain may become + * unmigratable during migration. This will cancel the ongoing + * migration. * * Returns the new domain object if the migration was successful, * or NULL in case of error. Note that the new domain object @@ -5423,7 +5426,10 @@ error: * There are many limitations on migration imposed by the underlying * technology - for example it may not be possible to migrate between * different processors even with the same architecture, or between - * different types of hypervisor. + * different types of hypervisor. A domain may not be migratable + * because of configuration or error states. A domain may become + * unmigratable during migration. This will cancel the ongoing + * migration. * * If the hypervisor supports it, @dxml can be used to alter * host-specific portions of the domain XML that will be used on @@ -5664,7 +5670,10 @@ error: * There are many limitations on migration imposed by the underlying * technology - for example it may not be possible to migrate between * different processors even with the same architecture, or between - * different types of hypervisor. + * different types of hypervisor. A domain may not be migratable + * because of configuration or error states. A domain may become + * unmigratable during migration. This will cancel the ongoing + * migration. * * Returns 0 if the migration succeeded, -1 upon error. */ @@ -5826,7 +5835,10 @@ error: * There are many limitations on migration imposed by the underlying * technology - for example it may not be possible to migrate between * different processors even with the same architecture, or between - * different types of hypervisor. + * different types of hypervisor. A domain may not be migratable + * because of configuration or error states. A domain may become + * unmigratable during migration. This will cancel the ongoing + * migration. * * Returns 0 if the migration succeeded, -1 upon error. */ -- 1.8.2.1