[libvirt] [PATCH] virsh: Document that using incomplete XML files may have unexpected results

Explicitly state that using incomplete XML definition snippets for hot-management commands may have unexpected results due to autogenerating values for some of the fields if they aren't specified explicitly. --- tools/virsh.pod | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/tools/virsh.pod b/tools/virsh.pod index 1510d0d..11984bc 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -1824,6 +1824,10 @@ within an existing device; consider using B<update-device> for this usage. For passthrough host devices, see also B<nodedev-detach>, needed if the device does not use managed mode. +B<Note>: using of partial device definition XML files may lead to unexpected +results as some fields may be autogenerated and thus match devices other than +expected. + =item B<attach-disk> I<domain> I<source> I<target> [I<--driver driver>] [I<--subdriver subdriver>] [I<--cache cache>] [I<--type type>] [I<--mode mode>] [I<--config>] [I<--sourcetype soucetype>] @@ -1893,6 +1897,10 @@ as command B<attach-device>. For passthrough host devices, see also B<nodedev-reattach>, needed if the device does not use managed mode. +B<Note>: using of partial device definition XML files may lead to unexpected +results as some fields may be autogenerated and thus match devices other than +expected. + 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. @@ -1969,6 +1977,10 @@ 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>. +B<Note>: using of partial device definition XML files may lead to unexpected +results as some fields may be autogenerated and thus match devices other than +expected. + =item B<change-media> I<domain> I<path> [I<--eject>] [I<--insert>] [I<--update>] [I<source>] [I<--force>] [[I<--live>] [I<--config>] | [I<--current>]] -- 1.8.1.5

On 04/11/2013 08:32 AM, Peter Krempa wrote:
Explicitly state that using incomplete XML definition snippets for hot-management commands may have unexpected results due to autogenerating values for some of the fields if they aren't specified explicitly. --- tools/virsh.pod | 12 ++++++++++++ 1 file changed, 12 insertions(+)
ACK. -- Eric Blake eblake redhat com +1-919-301-3266 Libvirt virtualization library http://libvirt.org

On 04/11/13 16:37, Eric Blake wrote:
On 04/11/2013 08:32 AM, Peter Krempa wrote:
Explicitly state that using incomplete XML definition snippets for hot-management commands may have unexpected results due to autogenerating values for some of the fields if they aren't specified explicitly. --- tools/virsh.pod | 12 ++++++++++++ 1 file changed, 12 insertions(+)
ACK.
Pushed. Thanks! Peter
participants (2)
-
Eric Blake
-
Peter Krempa