[libvirt] [libvirt-virshcmdref 01/14] update documentation for command attach-device
Eric Blake
eblake at redhat.com
Thu Aug 25 18:20:59 UTC 2011
On 08/25/2011 02:14 AM, Hu Tao wrote:
> ---
> source/attach-device.xml | 143 ++++++++++++++++++++++++++++++++++++++++++++--
> 1 files changed, 137 insertions(+), 6 deletions(-)
>
> diff --git a/source/attach-device.xml b/source/attach-device.xml
> index efa46f0..18e3262 100644
> --- a/source/attach-device.xml
> +<parameter requirement="required">
> +<keyword requirement="optional">--file</keyword>
> +<value type="string" requirement="required">file</value>
> +<description>
> +<text>
> + the XML file describing the device to be attached
It takes me reading from here,...
> + Now we attach a NIC to the domain:
> +</text>
> +<terminal>virsh #<bold>attach-device</bold> <value>example-domain</value> <value>/tmp/new-nic.xml</value></terminal>
> +<text>
> + the content of<value>/tmp/new-nic.xml</value> is:
> +</text>
> +<terminal>
> +<interface type='network'>
> +<source network='default'/>
> +</interface></terminal>
...until here, after several examples, before I finally learn what forms
a valid .xml file. I'm wondering if it would help exposition to mention
what constitutes valid xml sooner in the page. Maybe:
the XML file describing the device to be attached, with a root element
of something that belongs inside <devices> of domain xml
But that would be a separate cleanup that applies not only here to
attach-device, but also to detach-device and update-device, so it can be
a later patch.
What you have is a strict improvement and looks correct, so ACK and pushed.
--
Eric Blake eblake at redhat.com +1-801-349-2682
Libvirt virtualization library http://libvirt.org
More information about the libvir-list
mailing list