[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

Re: [libvirt] [PATCH 1/1] Clarify what documentation is being referenced



On 02/27/2012 03:51 PM, Dave Allan wrote:
> virsh.pod had several instances in which it referred to "the
> documentation" which was a little puzzling to me since it is
> documentation.  Reading the document from end to end makes it clear
> that it means a specific URI which was noted previously in the text,
> but I had never noticed those URI in several years of referring to the
> man page.  This patch adds those URIs to several additional places in
> the text.
> ---
>  tools/virsh.pod |   38 ++++++++++++++++++++++----------------
>  1 files changed, 22 insertions(+), 16 deletions(-)

Much nicer.  ACK with one nit.

>  =item B<attach-device> I<domain-id> I<FILE>
> 
> -Attach a device to the domain, using a device definition in an XML file.
> -See the documentation to learn about libvirt XML format for a device.
> -For cdrom and floppy devices, this command only replaces the media within
> -the single existing device; consider using B<update-device> for this usage.
> -For passthrough host devices, see also B<nodedev-dettach>, needed if
> -the device does not use managed mode.
> +Attach a device to the domain, using a device definition in an XML
> +file.  See the documentation at
> +L<http://libvirt.org/formatdomain.html> to learn about libvirt XML

Here, I'd link to formatdomain.html#elementsDevices, as well as
specifically mention an example or two of the valid top-level elements
we are looking for.  Maybe:

...using a device definition (such as <disk> or <interface>) as the
top-level element in an XML file.  See the documentation...

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

Attachment: signature.asc
Description: OpenPGP digital signature


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]