diff options
author | Tomas Meszaros <exo@tty.sk> | 2015-08-18 22:22:07 +0200 |
---|---|---|
committer | Martin Kletzander <mkletzan@redhat.com> | 2015-08-24 15:20:35 +0200 |
commit | 6c2702eddf468ec71ab021873af7c7ae0b09f30f (patch) | |
tree | 219921ccafa73d5d07b16fb01667b1610db24857 | |
parent | c8e5177303f1b17a5e3116c6a8693391a3539bb9 (diff) | |
download | libvirt-6c2702eddf468ec71ab021873af7c7ae0b09f30f.tar.gz |
virDomainRename: Extend API documentation
Signed-off-by: Tomas Meszaros <exo@tty.sk>
-rw-r--r-- | src/libvirt-domain.c | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c index 5c8bf2bc10..cbf08fc8c8 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 + * 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 |