[libvirt] [PATCH] virDomainReboot: Document that migration might be unsafe

[Michal Privoznik]

https://bugzilla.redhat.com/show_bug.cgi?id=744967

If a domain is rebooting and a migrate API is called meanwhile we would
have to transfer the fakeReboot attribute to the destination in order to
prevent domain doing plain shutdown over there. We shouldn't try to do
anything clever about it other than documenting this as known
limitation.

Signed-off-by: Michal Privoznik <mprivozn at redhat.com>
---
 src/libvirt.c | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/libvirt.c b/src/libvirt.c
index ae05300..c4c6d5c 100644
--- a/src/libvirt.c
+++ b/src/libvirt.c
@@ -3434,6 +3434,11 @@ error:
  * To use guest agent (VIR_DOMAIN_REBOOT_GUEST_AGENT) the domain XML
  * must have <channel> configured.
  *
+ * Due to a implementation limitations in some drivers (the qemu driver,
+ * for instance) it is not advised to migrate or save a guest that is
+ * rebooting as a result of this API. Migrating such guest can lead to a
+ * plain shutdown on the destination.
+ *
  * Returns 0 in case of success and -1 in case of failure.
  */
 int
-- 
1.8.4.4