[libvirt] [PATCH 2/4] docs: boot order for host and redirected USB devices

[Michal Privoznik]

On 20.11.2012 19:47, Ján Tomko wrote:
> And a few spaces.
> ---
>  docs/formatdomain.html.in |   27 +++++++++++++++++++--------
>  1 files changed, 19 insertions(+), 8 deletions(-)
> 
> diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
> index c8da33d..6a3b976 100644
> --- a/docs/formatdomain.html.in
> +++ b/docs/formatdomain.html.in
> @@ -2192,7 +2192,8 @@
>        boot sequence. The per-device <code>boot</code> elements cannot be
>        used together with general boot elements in
>        <a href="#elementsOSBIOS">BIOS bootloader</a> section.
> -      <span class="since">Since 0.8.8</span></dd>
> +      <span class="since">Since 0.8.8</span> for PCI devices,
> +      <span class="since">Since 1.0.1</span> for USB devices.
>        <dt><code>rom</code></dt>
>        <dd>The <code>rom</code> element is used to change how a PCI
>          device's ROM is presented to the guest. The optional <code>bar</code>
> @@ -2237,6 +2238,7 @@
>    <devices>
>      <redirdev bus='usb' type='tcp'>
>        <source mode='connect' host='localhost' service='4000'/>
> +      <boot order='1'/>
>      </redirdev>
>      <redirfilter>
>        <usbdev class='0x08' vendor='0x1234' product='0xbeef' version='2.00' allow='yes'/>
> @@ -2258,24 +2260,33 @@
>          tunnel; <code>type='tcp'</code>
>          or <code>type='spicevmc'</code> (which uses the usbredir
>          channel of a <a href="#elementsGraphics">SPICE graphics
> -        device</a>) are typical.The redirdev element has an optional
> -        sub-element<code><address></code> which can tie the
> +        device</a>) are typical. The redirdev element has an optional
> +        sub-element <code><address></code> which can tie the

While these changes are technically correct, they don't belong to this
patch.

>          device to a particular controller. Further sub-elements,
>          such as <code><source></code>, may be required according
>          to the given type, although a <code><target></code> sub-element
>          is not required (since the consumer of the character device is
> -        the hypervisor itself,rather than a device visible in the guest).
> +        the hypervisor itself, rather than a device visible in the guest).
> +      </dd>
> +      <dt><code>boot</code></dt>
> +
> +      <dd>Specifies that the device is bootable.
> +        The <code>order</code> attribute determines the order in which
> +        devices will be tried during boot sequence. The per-device
> +        <code>boot</code> elements cannot be used together with general
> +        boot elements in  <a href="#elementsOSBIOS">BIOS bootloader</a> section.
> +        (<span class="since">Since 1.0.1</span>)
>        </dd>
>        <dt><code>redirfilter</code></dt>
>        <dd>The<code> redirfilter </code>element is used for creating the
>          filter rule to filter out certain devices from redirection.
> -        It uses sub-element <code><usbdev></code>to define each filter rule.
> -        <code>class</code>attribute is the USB Class code, for example,
> +        It uses sub-element <code><usbdev></code> to define each filter rule.
> +        <code>class</code> attribute is the USB Class code, for example,
>          0x08 represents mass storage devices. The USB device can be addressed by
> -        vendor / product id using the<code>vendor</code> and <code>product</code> attributes.
> +        vendor / product id using the <code>vendor</code> and <code>product</code> attributes.
>          <code>version</code> is the bcdDevice value of USB device, such as 1.00, 1.10 and 2.00.
>          These four attributes are optional and <code>-1</code> can be used to allow
> -        any value for them. <code>allow</code>attribute is mandatory,
> +        any value for them. <code>allow</code> attribute is mandatory,
>          'yes' means allow, 'no' for deny.
>        </dd>
>      </dl>
> 

ACK to all changes, though.

Michal