virDomainReboot: Document that migration might be unsafe

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 a known
limitation.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>

diff --git a/src/libvirt.c b/src/libvirt.c
index 9355d33c4157f2bbab79fa2c2ada0e5523c8574a..eff44eb72b8f2350feb10d7ae526c1441cae90ca 100644 (file)
--- 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 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 a guest can lead
+ * to a plain shutdown on the destination.
+ *
  * Returns 0 in case of success and -1 in case of failure.
  */
 int