[v4,0/5] doc/features: fix some features and add new features

Message ID 20231127141659.46600-1-lihuisong@huawei.com (mailing list archive)
Headers
Series doc/features: fix some features and add new features |

Message

lihuisong (C) Nov. 27, 2023, 2:16 p.m. UTC
  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 to RSS hash
and perfect RSS other features by the way.

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

---
 -v4:
   - fix RSS releated feaures description based on Ferruh
   - add new features to default.ini
   - remove loopback patch.
   - move "dump device private information" to "dev ops" block.

 -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 (5):
  doc: fix the description of RSS related feature
  doc: add link up/down feature
  doc: add features for link speeds
  doc: add Traffic Manager feature
  doc: add dump device private information ops

 doc/guides/nics/features.rst         | 47 +++++++++++++++++++++++++---
 doc/guides/nics/features/default.ini |  2 ++
 2 files changed, 45 insertions(+), 4 deletions(-)
  

Comments

Ferruh Yigit Nov. 27, 2023, 4:44 p.m. UTC | #1
On 11/27/2023 2:16 PM, 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 to RSS hash
> and perfect RSS other features by the way.
> 
> In addition, serval features or interface, like "set link up/down", "TM",
> "link speeds" and "dump device private information" had beed supported,
> but they are absent from the freatures list.
> 
> ---
>  -v4:
>    - fix RSS releated feaures description based on Ferruh
>    - add new features to default.ini
>    - remove loopback patch.
>    - move "dump device private information" to "dev ops" block.
> 
>  -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 (5):
>   doc: fix the description of RSS related feature
>   doc: add link up/down feature
>   doc: add features for link speeds
>   doc: add Traffic Manager feature
>   doc: add dump device private information ops
> 

As mentioned before I don't know about adding link speed feature or not,
would like to get more comment.

But for the new features added, driver .ini files also needs to be
updated for that new feature, and drivers support it should mark the
support.
That is why it is best to start documenting a feature when it is first
introduced, otherwise it is more work to update it later.
  
Ferruh Yigit Nov. 27, 2023, 4:56 p.m. UTC | #2
On 11/27/2023 2:16 PM, 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 to RSS hash
> and perfect RSS other features by the way.
> 
> In addition, serval features or interface, like "set link up/down", "TM",
> "link speeds" and "dump device private information" had beed supported,
> but they are absent from the freatures list.
> 
> ---
>  -v4:
>    - fix RSS releated feaures description based on Ferruh
>    - add new features to default.ini
>    - remove loopback patch.
>    - move "dump device private information" to "dev ops" block.
> 
>  -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 (5):
>   doc: fix the description of RSS related feature
>   doc: add link up/down feature
>   doc: add features for link speeds
>   doc: add Traffic Manager feature
>   doc: add dump device private information ops
> 

Please check the warning on document generation:
https://mails.dpdk.org/archives/test-report/2023-November/519586.html

/home/runner/work/dpdk/dpdk/doc/guides/nics/features.rst:307:Unexpected
indentation.
  
lihuisong (C) Nov. 28, 2023, 2:09 a.m. UTC | #3
在 2023/11/28 0:44, Ferruh Yigit 写道:
> On 11/27/2023 2:16 PM, 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 to RSS hash
>> and perfect RSS other features by the way.
>>
>> In addition, serval features or interface, like "set link up/down", "TM",
>> "link speeds" and "dump device private information" had beed supported,
>> but they are absent from the freatures list.
>>
>> ---
>>   -v4:
>>     - fix RSS releated feaures description based on Ferruh
>>     - add new features to default.ini
>>     - remove loopback patch.
>>     - move "dump device private information" to "dev ops" block.
>>
>>   -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 (5):
>>    doc: fix the description of RSS related feature
>>    doc: add link up/down feature
>>    doc: add features for link speeds
>>    doc: add Traffic Manager feature
>>    doc: add dump device private information ops
>>
> As mentioned before I don't know about adding link speed feature or not,
> would like to get more comment.
ok, let us to get more comment.
it is better that we send a separated patch about link speed feature to 
discuss and get more comment.
In this way, other patch in this series also go ahead to upload.
what do you think?
>
> But for the new features added, driver .ini files also needs to be
> updated for that new feature, and drivers support it should mark the
> support.
agree.
I will add "Traffic Manager" feature to driver.ini for the supported TM 
driver.
But I'm not sure if I am supposed to do this in patch 4/5 or send 
independent patch for every supported driver.
what do you think of that?
> That is why it is best to start documenting a feature when it is first
> introduced, otherwise it is more work to update it later.
agree with you.
we should remind someone to add it to this feature doc when a new 
feature is introduced.
>
> .
  
lihuisong (C) Nov. 28, 2023, 2:23 a.m. UTC | #4
在 2023/11/28 0:56, Ferruh Yigit 写道:
> On 11/27/2023 2:16 PM, 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 to RSS hash
>> and perfect RSS other features by the way.
>>
>> In addition, serval features or interface, like "set link up/down", "TM",
>> "link speeds" and "dump device private information" had beed supported,
>> but they are absent from the freatures list.
>>
>> ---
>>   -v4:
>>     - fix RSS releated feaures description based on Ferruh
>>     - add new features to default.ini
>>     - remove loopback patch.
>>     - move "dump device private information" to "dev ops" block.
>>
>>   -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 (5):
>>    doc: fix the description of RSS related feature
>>    doc: add link up/down feature
>>    doc: add features for link speeds
>>    doc: add Traffic Manager feature
>>    doc: add dump device private information ops
>>
> Please check the warning on document generation:
> https://mails.dpdk.org/archives/test-report/2023-November/519586.html
>
> /home/runner/work/dpdk/dpdk/doc/guides/nics/features.rst:307:Unexpected
> indentation.
Here has a format issue. I will fix it next version.
Thanks.
>
> .
  
lihuisong (C) Nov. 28, 2023, 4:07 a.m. UTC | #5
在 2023/11/28 10:09, lihuisong (C) 写道:
>
> 在 2023/11/28 0:44, Ferruh Yigit 写道:
>> On 11/27/2023 2:16 PM, 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 to 
>>> RSS hash
>>> and perfect RSS other features by the way.
>>>
>>> In addition, serval features or interface, like "set link up/down", 
>>> "TM",
>>> "link speeds" and "dump device private information" had beed supported,
>>> but they are absent from the freatures list.
>>>
>>> ---
>>>   -v4:
>>>     - fix RSS releated feaures description based on Ferruh
>>>     - add new features to default.ini
>>>     - remove loopback patch.
>>>     - move "dump device private information" to "dev ops" block.
>>>
>>>   -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 (5):
>>>    doc: fix the description of RSS related feature
>>>    doc: add link up/down feature
>>>    doc: add features for link speeds
>>>    doc: add Traffic Manager feature
>>>    doc: add dump device private information ops
>>>
>> As mentioned before I don't know about adding link speed feature or not,
>> would like to get more comment.
> ok, let us to get more comment.
> it is better that we send a separated patch about link speed feature 
> to discuss and get more comment.
> In this way, other patch in this series also go ahead to upload.
> what do you think?
>>
>> But for the new features added, driver .ini files also needs to be
>> updated for that new feature, and drivers support it should mark the
>> support.
> agree.
> I will add "Traffic Manager" feature to driver.ini for the supported 
> TM driver.
> But I'm not sure if I am supposed to do this in patch 4/5 or send 
> independent patch for every supported driver.
Thinking twice, I will separate this "TM" patch from this series and 
send a independent patchset to do this.
Then we can take a look at that series.
> what do you think of that?
>> That is why it is best to start documenting a feature when it is first
>> introduced, otherwise it is more work to update it later.
> agree with you.
> we should remind someone to add it to this feature doc when a new 
> feature is introduced.
>>
>> .
> .