virDomainRename: Extend API documentation

Signed-off-by: Tomas Meszaros <exo@tty.sk>
This commit is contained in:
Tomas Meszaros 2015-08-18 22:22:07 +02:00 committed by Martin Kletzander
parent c8e5177303
commit 6c2702eddf

View File

@ -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