[libvirt] [PATCH] docs: tweak 'virsh edit' wording

Eric Blake eblake at redhat.com
Mon Dec 12 21:31:10 UTC 2011

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 |    8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/tools/virsh.pod b/tools/virsh.pod
index fe92714..965b215 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -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 domain > domain.xml
  vi domain.xml (or make changes with your other text editor)
  virsh define domain.xml


More information about the libvir-list mailing list