[v3,0/6] doc/features: fix some features and add new features

  The support for setting RSS hash algorithm has been introduced to 23.11,
but doesn't add feature for it. So this series add this feature and perfect
RSS other features by the way.

In addition, serval features, like "set link up/down", "TM", "dump device
private information" and "loopback mode", had beed supported, but they are
absent from the freatures list.

---
 -v3:
   - fix description of the patchset cover
   - remove '/features' in 'doc/features' tag for every patch.
   - add Acked-by: Chengwen Feng <fengchengwen@huawei.com>
   - retrigger CI build because of wrong CI warning

 -v2:
   - add loopback mode feature.

Huisong Li (6):
  doc: add RSS hash algorithm feature
  doc: add link up/down feature
  doc: add features for link speeds
  doc: add Traffic Manager feature
  doc: add dump device private information feature
  doc: add feature for loopback mode

 doc/guides/nics/features.rst | 78 ++++++++++++++++++++++++++++++++++--
 1 file changed, 74 insertions(+), 4 deletions(-)
  

On 11/25/2023 1:47 AM, Huisong Li wrote:
> The support for setting RSS hash algorithm has been introduced to 23.11,
> but doesn't add feature for it. So this series add this feature and perfect
> RSS other features by the way.
> 
> In addition, serval features, like "set link up/down", "TM", "dump device
> private information" and "loopback mode", had beed supported, but they are
> absent from the freatures list.
> 
> ---
>  -v3:
>    - fix description of the patchset cover
>    - remove '/features' in 'doc/features' tag for every patch.
>    - add Acked-by: Chengwen Feng <fengchengwen@huawei.com>
>    - retrigger CI build because of wrong CI warning
> 
>  -v2:
>    - add loopback mode feature.
> 
> Huisong Li (6):
>   doc: add RSS hash algorithm feature
>   doc: add link up/down feature
>   doc: add features for link speeds
>   doc: add Traffic Manager feature
>   doc: add dump device private information feature
>   doc: add feature for loopback mode
> 
>  

Hi Huisong,

Some of the patches above adds new features to the 'features.rst', but
features.rst document describes features that drivers mark in feature
list in .ini file, all features are listed in the 'default.ini'.

When a new feature is added into 'default.ini', it can be described in
'features.rst' and later all driver .ini files should be updated to
reflect if they support this feature or not.


And I think no need to document all features, but ones can be important
enough or differentiating features for users to know, this line is not
easy to draw, so perhaps we can use community consensus to select.

In this patch following features are added:
- Link speed configuration
- Traffic manager
- Device private information dump
- Loopback configuration


I think 'Traffic manager' can be a new feature, but I am not sure about
rest. It would be nice to get more comments.
  

在 2023/11/27 20:35, Ferruh Yigit 写道:
> On 11/25/2023 1:47 AM, Huisong Li wrote:
>> The support for setting RSS hash algorithm has been introduced to 23.11,
>> but doesn't add feature for it. So this series add this feature and perfect
>> RSS other features by the way.
>>
>> In addition, serval features, like "set link up/down", "TM", "dump device
>> private information" and "loopback mode", had beed supported, but they are
>> absent from the freatures list.
>>
>> ---
>>   -v3:
>>     - fix description of the patchset cover
>>     - remove '/features' in 'doc/features' tag for every patch.
>>     - add Acked-by: Chengwen Feng <fengchengwen@huawei.com>
>>     - retrigger CI build because of wrong CI warning
>>
>>   -v2:
>>     - add loopback mode feature.
>>
>> Huisong Li (6):
>>    doc: add RSS hash algorithm feature
>>    doc: add link up/down feature
>>    doc: add features for link speeds
>>    doc: add Traffic Manager feature
>>    doc: add dump device private information feature
>>    doc: add feature for loopback mode
>>
>>   
> Hi Huisong,
>
> Some of the patches above adds new features to the 'features.rst', but
> features.rst document describes features that drivers mark in feature
> list in .ini file, all features are listed in the 'default.ini'.
>
> When a new feature is added into 'default.ini', it can be described in
> 'features.rst' and later all driver .ini files should be updated to
> reflect if they support this feature or not.
correct.
>
> And I think no need to document all features, but ones can be important
> enough or differentiating features for users to know, this line is not
agree with you.
> easy to draw, so perhaps we can use community consensus to select.
>
> In this patch following features are added:
> - Link speed configuration
> - Traffic manager
> - Device private information dump
> - Loopback configuration
>
>
> I think 'Traffic manager' can be a new feature, but I am not sure about
> rest. It would be nice to get more comments.
Link speed is also important for NIC. Fixed speed and Link autoneg is 
from this.
I think it can be a new feature. what do you think?
How about add others to the following block?
"Other dev ops not represented by a Feature"
> .
  

On 11/27/2023 1:37 PM, lihuisong (C) wrote:
> 
> 在 2023/11/27 20:35, Ferruh Yigit 写道:
>> On 11/25/2023 1:47 AM, Huisong Li wrote:
>>> The support for setting RSS hash algorithm has been introduced to 23.11,
>>> but doesn't add feature for it. So this series add this feature and
>>> perfect
>>> RSS other features by the way.
>>>
>>> In addition, serval features, like "set link up/down", "TM", "dump
>>> device
>>> private information" and "loopback mode", had beed supported, but
>>> they are
>>> absent from the freatures list.
>>>
>>> ---
>>>   -v3:
>>>     - fix description of the patchset cover
>>>     - remove '/features' in 'doc/features' tag for every patch.
>>>     - add Acked-by: Chengwen Feng <fengchengwen@huawei.com>
>>>     - retrigger CI build because of wrong CI warning
>>>
>>>   -v2:
>>>     - add loopback mode feature.
>>>
>>> Huisong Li (6):
>>>    doc: add RSS hash algorithm feature
>>>    doc: add link up/down feature
>>>    doc: add features for link speeds
>>>    doc: add Traffic Manager feature
>>>    doc: add dump device private information feature
>>>    doc: add feature for loopback mode
>>>
>>>   
>> Hi Huisong,
>>
>> Some of the patches above adds new features to the 'features.rst', but
>> features.rst document describes features that drivers mark in feature
>> list in .ini file, all features are listed in the 'default.ini'.
>>
>> When a new feature is added into 'default.ini', it can be described in
>> 'features.rst' and later all driver .ini files should be updated to
>> reflect if they support this feature or not.
> correct.
>>
>> And I think no need to document all features, but ones can be important
>> enough or differentiating features for users to know, this line is not
> agree with you.
>> easy to draw, so perhaps we can use community consensus to select.
>>
>> In this patch following features are added:
>> - Link speed configuration
>> - Traffic manager
>> - Device private information dump
>> - Loopback configuration
>>
>>
>> I think 'Traffic manager' can be a new feature, but I am not sure about
>> rest. It would be nice to get more comments.
> Link speed is also important for NIC. Fixed speed and Link autoneg is
> from this.
> I think it can be a new feature. what do you think?
>

Target is to document what a device/driver supports in DPDK, this may
help end user quickly check and see what to expect from a device/driver.

Also helps to gauge how feature complete a driver implementation is.


Is there a value to document if setting fixed speed supported for end
user? My assumption is mostly autoneg is used.


> How about add others to the following block?
> "Other dev ops not represented by a Feature"
> 

Yes there are some dev_ops, implemented by drivers but not documented in
the feature.rst .

Indeed it would be nice to document them too somehow, perhaps not as
part of the feature.rst, but it has its own document for these dev_ops,
and feature.rst can have link to them?