summaryrefslogtreecommitdiff
path: root/tools/virsh.pod
diff options
context:
space:
mode:
authorPeter Krempa <pkrempa@redhat.com>2013-03-15 17:11:28 +0100
committerPeter Krempa <pkrempa@redhat.com>2013-04-02 16:14:14 +0200
commit69ce3ffa8d431e9810607c6e00b7cfcc481b491d (patch)
treecab7232f713e019d112f114741adee68c6fe71ec /tools/virsh.pod
parentcc0cc6b714a3aeff1a8abecb26ef8d246b5e65b3 (diff)
downloadlibvirt-69ce3ffa8d431e9810607c6e00b7cfcc481b491d.tar.gz
virsh: Fix semantics of --config for "update-device" command
The man page states that with --config the next boot is affected. This can be understood as if _only_ the next boot was affected. This isn't true if the machine is running. This patch adds the full --live, --config, --current infrastructure and tweaks stuff to correctly support the obsolete --persistent flag. Note that this patch changes the the behavior of the --config flag to match the use of this flag in rest of libvirt. This flag was mistakenly renamed from --persistent that originaly had different semantics.
Diffstat (limited to 'tools/virsh.pod')
-rw-r--r--tools/virsh.pod24
1 files changed, 17 insertions, 7 deletions
diff --git a/tools/virsh.pod b/tools/virsh.pod
index e7e82e35d4..04ea542ca1 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -1888,18 +1888,28 @@ If I<--config> is specified, alter persistent configuration, effect observed
on next boot, for compatibility purposes, I<--persistent> is alias of
I<--config>.
-=item B<update-device> I<domain> I<file> [I<--config>] [I<--force>]
+=item B<update-device> I<domain> I<file> [I<--force>]
+[[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]]
Update the characteristics of a device associated with I<domain>,
-based on the device definition in an XML I<file>. If the I<--config>
-option is used, the changes will take affect the next time libvirt
-starts the domain. For compatibility purposes, I<--persistent> is
-alias of I<--config>. The I<--force> option can be used to force
-device update, e.g., to eject a CD-ROM even if it is locked/mounted in
-the domain. See the documentation at
+based on the device definition in an XML I<file>. The I<--force> option
+can be used to force device update, e.g., to eject a CD-ROM even if it is
+locked/mounted in the domain. See the documentation at
L<http://libvirt.org/formatdomain.html#elementsDevices> to learn about
libvirt XML format for a device.
+If I<--live> is specified, affect a running domain.
+If I<--config> is specified, affect the next startup of a persistent domain.
+If I<--current> is specified, affect the current domain state.
+Both I<--live> and I<--config> flags may be given, but I<--current> is
+exclusive. Not specifying any flag is the same as specifying I<--current>.
+
+For compatibility purposes, I<--persistent> behaves like I<--config> for
+an offline domain, and like I<--live> I<--config> for a running domain.
+
+Note that older versions of virsh used I<--config> as an alias for
+I<--persistent>.
+
=item B<change-media> I<domain> I<path> [I<--eject>] [I<--insert>]
[I<--update>] [I<source>] [I<--force>] [[I<--live>] [I<--config>] | [I<--current>]]