[libvirt] [PATCH] virDomainRename: Extended API documentation
Signed-off-by: Tomas Meszaros <exo(a)tty.sk>
---
src/libvirt-domain.c | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index 5c8bf2b..60e0def 100644
--- 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
+ * 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
--
2.1.0