[libvirt] [PATCH] 514532 Fix man page, most operation are synchronous

Daniel Veillard veillard at redhat.com
Wed Nov 18 13:31:12 UTC 2009

As pointed in https://bugzilla.redhat.com/show_bug.cgi?id=514532
we were historically warning about operation being asynchronous
in the man page but actually most operations are synchronous.
I still kept a warning about domain creation and shutdown, maybe
we should add a few more, but as is this is mostly correct and
better than the current description IMHO
Maybe we should flag formally in the description all APIs which
have an asynchronous behaviour.

    514532 Fix man page, most operation are synchronous

    * tools/virsh.pod: the man page was stating that most operations
      are asynchronous while in fact most of them are synchronous except
      domain creation and shutdown

diff --git a/tools/virsh.pod b/tools/virsh.pod
index 55ec64a..2986c34 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -40,12 +40,11 @@ Most B<virsh> commands require root privileges to run due to the
 communications channels used to talk to the hypervisor.  Running as
 non root will return an error.
-Most B<virsh> commands act asynchronously, so just because the B<virsh>
-program returned, doesn't mean the action is complete.  This is
-important, as many operations on domains, like create and shutdown,
-can take considerable time (30 seconds or more) to bring the machine
-into a fully compliant state.  If you want to know when one of these
-actions has finished you must poll through virsh list periodically.
+Most B<virsh> commands act synchronously, except maybe shutdown
+and domain creation. In those case the fact that the B<virsh>
+program returned, may not mean the action is complete and you
+must poll through virsh list periodically to detect that the
+operation completed.

Daniel Veillard      | libxml Gnome XML XSLT toolkit  http://xmlsoft.org/
daniel at veillard.com  | Rpmfind RPM search engine http://rpmfind.net/
http://veillard.com/ | virtualization library  http://libvirt.org/

More information about the libvir-list mailing list