[PATCH v2 14/29] formatdomain.rst: add 'index' semantics for PowerNV domains

[Daniel Henrique Barboza]

On 2/21/22 10:21, Ján Tomko wrote:
> On a Tuesday in 2022, Daniel Henrique Barboza wrote:
>> We're going to use the 'targetIndex' element for PowerNV PHBs. Clarify
>> that the same attribute will have a different meaning in this context.
>>
>> Signed-off-by: Daniel Henrique Barboza <danielhb413 at gmail.com>
>> ---
>> docs/formatdomain.rst | 6 ++++--
>> 1 file changed, 4 insertions(+), 2 deletions(-)
>>
>> diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
>> index 1e44d9a987..d700049c1c 100644
>> --- a/docs/formatdomain.rst
>> +++ b/docs/formatdomain.rst
>> @@ -3896,8 +3896,10 @@ generated by libvirt. :since:`Since 1.2.19 (QEMU only).`
>>    the user of the libvirt API to attach host devices to the correct
>>    pci-expander-bus when assigning them to the domain).
>> ``index``
>> -   pci-root controllers for pSeries guests use this attribute to record the
>> -   order they will show up in the guest. :since:`Since 3.6.0`
>> +   pci-root controllers for ``pSeries`` guests use this attribute to record the
>> +   order they will show up in the guest (:since:`Since 3.6.0`). :since:`Since 8.1.0`,
>> +   ``powernv`` domains uses this attribute to indicate the chip/socket slot a
>> +   pcie-root controller will use.
> 
> The clarification did not help me. I see no difference between this
> description and the one for the chip-id attribute


Changed the description to:


``index``
    pci-root controllers for ``pSeries`` guests use this attribute to record the
    order they will show up in the guest (:since:`Since 3.6.0`). :since:`Since 8.1.0`,
    ``powernv`` domains uses this attribute to indicate which slot inside the
    chip the pcie-root controller will use.



Thanks,


Daniel



> 
> Jano
> 
>> ``chip-id``
>>    pcie-root controllers for ``powernv`` domains use this attribute to indicate
>>    the chip that will own the controller. A chip is equivalent to a CPU socket.
>> -- 
>> 2.34.1
>>