]> xenbits.xensource.com Git - libvirt.git/commitdiff
docs: tweak 'virsh edit' wording
authorEric Blake <eblake@redhat.com>
Mon, 12 Dec 2011 21:28:31 +0000 (14:28 -0700)
committerEric Blake <eblake@redhat.com>
Tue, 13 Dec 2011 22:58:43 +0000 (15:58 -0700)
I was wondering why 'virsh edit' didn't support the same
'--inactive' option as 'virsh dumpxml'; reading the source
code showed that --inactive was already implied, and that
the only way to alter a running guest rather than affecting
next boot is by hot-plugging individual devices, or by
something complex like saving the guest and modifying the
save image.

* tools/virsh.pod (define, edit): Mention behavior when guest is
already running.

tools/virsh.pod

index fe927140a8b1f2bb25aa8cc11f06cb9feae18651..d56c5d7d6de39ce34ab82e6e02bb17343d026ed6 100644 (file)
@@ -497,7 +497,8 @@ B<Example>
 =item B<define> I<FILE>
 
 Define a domain from an XML <file>. The domain definition is registered
-but not started.
+but not started.  If domain is already running, the changes will take
+effect on the next boot.
 
 =item B<destroy> I<domain-id>
 
@@ -717,11 +718,12 @@ specified, then the output will be escaped for use in XML.
 
 =item B<edit> I<domain-id>
 
-Edit the XML configuration file for a domain.
+Edit the XML configuration file for a domain, which will affect the
+next boot of the guest.
 
 This is equivalent to:
 
- virsh dumpxml domain > domain.xml
+ virsh dumpxml --inactive --security-info domain > domain.xml
  vi domain.xml (or make changes with your other text editor)
  virsh define domain.xml