virDomainRename: Extend API documentation

Signed-off-by: Tomas Meszaros <exo@tty.sk>

diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index 5c8bf2bc1019fd3ec531887a3284bc57452d52f2..cbf08fc8c8027a8f1fe6c1d0ff39b0d6f5d07f08 100644 (file)
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -8783,6 +8783,11 @@ virDomainIsPersistent(virDomainPtr dom)
  * argument. Depending on each driver implementation it may be
  * required that domain is in a specific state.
  *
+ * There might be some attributes and/or elements in domain XML that if no
+ * value provided at XML defining time, libvirt will derive their value from
+ * the domain name. These are not updated by this API. Users are strongly
+ * advised to change these after the rename was successful.
+ *
  * Returns 0 if successfully renamed, -1 on error
  */
 int