[libvirt] [PATCH REPOST 2/7] docs: clarify disk iothread support

[Cole Robinson]

On 05/03/2016 10:50 AM, John Ferlan wrote:
> 
> 
> On 05/03/2016 09:25 AM, Cole Robinson wrote:
>> On 05/02/2016 06:30 PM, John Ferlan wrote:
>>> Signed-off-by: John Ferlan <jferlan at redhat.com>
>>> ---
>>>  docs/formatdomain.html.in | 5 +++--
>>>  1 file changed, 3 insertions(+), 2 deletions(-)
>>>
>>> diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
>>> index bead624..735546e 100644
>>> --- a/docs/formatdomain.html.in
>>> +++ b/docs/formatdomain.html.in
>>> @@ -2561,8 +2561,9 @@
>>>              disk to an IOThread as defined by the range for the domain
>>>              <a href="#elementsIOThreadsAllocation"><code>iothreads</code></a>
>>>              value. Multiple devices may be assigned to the same IOThread and
>>> -            are numbered from 1 to the domain iothreads value.
>>> -            <span class='since'>Since 1.2.8 (QEMU only)</span>
>>> +            are numbered from 1 to the domain iothreads value. Available
>>> +            only for virtio-blk-pci and virtio-blk-ccw disks.
>>> +            <span class='since'>Since 1.2.8 (QEMU 2.1)</span>
>>>            </li>
>>>          </ul>
>>>        </dd>
>>>
>>
>> Those are qemu specific terms. I'd rather see it spelled out in libvirt terms
>> or something more end user readable.
>>
>> I see this mirrors the <iothreads> docs, instead I think the <iothread> docs
>> should just defer to the per-device docs to describe what device+version
>> combos support iothreads, so we don't need to update that info twice.
> 
> Does the following work better?
> 
> It removes the virtio-blk-{pci,ccw} from the <iothreads> description.
> Then in the <iothread> description for the disk <driver>, it's listed
> to essentially use <target ... bus='virtio'> for the <address type='pci'...>
> or <address type='ccw'...>
> 
> John
> 
> 
> diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
> index a103107..817d9c5 100644
> --- a/docs/formatdomain.html.in
> +++ b/docs/formatdomain.html.in
> @@ -566,7 +566,7 @@
>        <dd>
>          The content of this optional element defines the number
>          of IOThreads to be assigned to the domain for use by
> -        virtio-blk-pci and virtio-blk-ccw target storage devices. There
> +        supported target storage devices. There
>          should be only 1 or 2 IOThreads per host CPU. There may be more
>          than one supported device assigned to each IOThread.
>          <span class="since">Since 1.2.8</span>
> @@ -2560,9 +2560,11 @@
>              The optional <code>iothread</code> attribute assigns the
>              disk to an IOThread as defined by the range for the domain
>              <a href="#elementsIOThreadsAllocation"><code>iothreads</code></a>
> -            value. Multiple devices may be assigned to the same IOThread and
> -            are numbered from 1 to the domain iothreads value.
> -            <span class='since'>Since 1.2.8 (QEMU only)</span>
> +            value. Multiple disks may be assigned to the same IOThread and
> +            are numbered from 1 to the domain iothreads value. Available
> +            for a disk device <code>target</code> configured to use "virtio"
> +            <code>bus</code> and "pci" or "ccw" <code>address</code> types.
> +            <span class='since'>Since 1.2.8 (QEMU 2.1)</span>
>            </li>
>          </ul>
>        </dd>
> 

ACK to that

- Cole