[2/3] doc/hns3: update the features for hns3

Message ID 20231120075502.15844-3-lihuisong@huawei.com (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers
Series doc/hns3: fix hns3 doc |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

lihuisong (C) Nov. 20, 2023, 7:55 a.m. UTC
  Update the features for hns3.

Signed-off-by: Huisong Li <lihuisong@huawei.com>
---
 doc/guides/nics/hns3.rst | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)
  

Comments

Ferruh Yigit Nov. 20, 2023, 9:56 a.m. UTC | #1
On 11/20/2023 7:55 AM, Huisong Li wrote:
> Update the features for hns3.
> 
> Signed-off-by: Huisong Li <lihuisong@huawei.com>
> ---
>  doc/guides/nics/hns3.rst | 10 +++++++++-
>  1 file changed, 9 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
> index 7eac1b3c92..11d0c04884 100644
> --- a/doc/guides/nics/hns3.rst
> +++ b/doc/guides/nics/hns3.rst
> @@ -30,7 +30,6 @@ Features of the HNS3 PMD are:
>  - DCB
>  - Scattered and gather for TX and RX
>  - Vector Poll mode driver
> -- Dump register
>  - SR-IOV VF
>  - Multi-process
>  - MAC/VLAN filter
> @@ -38,6 +37,15 @@ Features of the HNS3 PMD are:
>  - NUMA support
>  - Generic flow API
>  - IEEE1588/802.1AS timestamping
> +- Basic stats
> +- Extended stats
> +- Traffic Management API
> +- Speed capabilities
> +- Link Auto-negotiation
> +- Link flow control
> +- Dump register
> +- Dump private info from device
> +- FW version
>  

Hi Huisong,

Can you please add fixes tag for each feature, to let track the relevant
code commit with claimed feature support?
  
lihuisong (C) Nov. 20, 2023, 10:48 a.m. UTC | #2
在 2023/11/20 17:56, Ferruh Yigit 写道:
> On 11/20/2023 7:55 AM, Huisong Li wrote:
>> Update the features for hns3.
>>
>> Signed-off-by: Huisong Li <lihuisong@huawei.com>
>> ---
>>   doc/guides/nics/hns3.rst | 10 +++++++++-
>>   1 file changed, 9 insertions(+), 1 deletion(-)
>>
>> diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
>> index 7eac1b3c92..11d0c04884 100644
>> --- a/doc/guides/nics/hns3.rst
>> +++ b/doc/guides/nics/hns3.rst
>> @@ -30,7 +30,6 @@ Features of the HNS3 PMD are:
>>   - DCB
>>   - Scattered and gather for TX and RX
>>   - Vector Poll mode driver
>> -- Dump register
>>   - SR-IOV VF
>>   - Multi-process
>>   - MAC/VLAN filter
>> @@ -38,6 +37,15 @@ Features of the HNS3 PMD are:
>>   - NUMA support
>>   - Generic flow API
>>   - IEEE1588/802.1AS timestamping
>> +- Basic stats
>> +- Extended stats
>> +- Traffic Management API
>> +- Speed capabilities
>> +- Link Auto-negotiation
>> +- Link flow control
>> +- Dump register
>> +- Dump private info from device
>> +- FW version
>>   
> Hi Huisong,
>
> Can you please add fixes tag for each feature, to let track the relevant
> code commit with claimed feature support?
Thanks for your advice.
Put fixes tag of each feature commit in the commit log of this patch, right?
Do we need to Cc stable?
>
>
> .
  
Ferruh Yigit Nov. 20, 2023, 10:53 a.m. UTC | #3
On 11/20/2023 10:48 AM, lihuisong (C) wrote:
> 
> 在 2023/11/20 17:56, Ferruh Yigit 写道:
>> On 11/20/2023 7:55 AM, Huisong Li wrote:
>>> Update the features for hns3.
>>>
>>> Signed-off-by: Huisong Li <lihuisong@huawei.com>
>>> ---
>>>   doc/guides/nics/hns3.rst | 10 +++++++++-
>>>   1 file changed, 9 insertions(+), 1 deletion(-)
>>>
>>> diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
>>> index 7eac1b3c92..11d0c04884 100644
>>> --- a/doc/guides/nics/hns3.rst
>>> +++ b/doc/guides/nics/hns3.rst
>>> @@ -30,7 +30,6 @@ Features of the HNS3 PMD are:
>>>   - DCB
>>>   - Scattered and gather for TX and RX
>>>   - Vector Poll mode driver
>>> -- Dump register
>>>   - SR-IOV VF
>>>   - Multi-process
>>>   - MAC/VLAN filter
>>> @@ -38,6 +37,15 @@ Features of the HNS3 PMD are:
>>>   - NUMA support
>>>   - Generic flow API
>>>   - IEEE1588/802.1AS timestamping
>>> +- Basic stats
>>> +- Extended stats
>>> +- Traffic Management API
>>> +- Speed capabilities
>>> +- Link Auto-negotiation
>>> +- Link flow control
>>> +- Dump register
>>> +- Dump private info from device
>>> +- FW version
>>>   
>> Hi Huisong,
>>
>> Can you please add fixes tag for each feature, to let track the relevant
>> code commit with claimed feature support?
> Thanks for your advice.
> Put fixes tag of each feature commit in the commit log of this patch,
> right?
>

Like for "Basic stats", add commit that introduces basic stats as fixes
line, same for each feature added above.


> Do we need to Cc stable?
>

For this case, main purpose for above fixes tags is to provide back
trace from document to the code,
but adding 'stable' tag enables backporting this document patch to LTS
release, which doesn't hurt, so please add stable tag too.
  
lihuisong (C) Nov. 20, 2023, 11:03 a.m. UTC | #4
在 2023/11/20 18:53, Ferruh Yigit 写道:
> On 11/20/2023 10:48 AM, lihuisong (C) wrote:
>> 在 2023/11/20 17:56, Ferruh Yigit 写道:
>>> On 11/20/2023 7:55 AM, Huisong Li wrote:
>>>> Update the features for hns3.
>>>>
>>>> Signed-off-by: Huisong Li <lihuisong@huawei.com>
>>>> ---
>>>>    doc/guides/nics/hns3.rst | 10 +++++++++-
>>>>    1 file changed, 9 insertions(+), 1 deletion(-)
>>>>
>>>> diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
>>>> index 7eac1b3c92..11d0c04884 100644
>>>> --- a/doc/guides/nics/hns3.rst
>>>> +++ b/doc/guides/nics/hns3.rst
>>>> @@ -30,7 +30,6 @@ Features of the HNS3 PMD are:
>>>>    - DCB
>>>>    - Scattered and gather for TX and RX
>>>>    - Vector Poll mode driver
>>>> -- Dump register
>>>>    - SR-IOV VF
>>>>    - Multi-process
>>>>    - MAC/VLAN filter
>>>> @@ -38,6 +37,15 @@ Features of the HNS3 PMD are:
>>>>    - NUMA support
>>>>    - Generic flow API
>>>>    - IEEE1588/802.1AS timestamping
>>>> +- Basic stats
>>>> +- Extended stats
>>>> +- Traffic Management API
>>>> +- Speed capabilities
>>>> +- Link Auto-negotiation
>>>> +- Link flow control
>>>> +- Dump register
>>>> +- Dump private info from device
>>>> +- FW version
>>>>    
>>> Hi Huisong,
>>>
>>> Can you please add fixes tag for each feature, to let track the relevant
>>> code commit with claimed feature support?
>> Thanks for your advice.
>> Put fixes tag of each feature commit in the commit log of this patch,
>> right?
>>
> Like for "Basic stats", add commit that introduces basic stats as fixes
> line, same for each feature added above.
ok
>
>
>> Do we need to Cc stable?
>>
> For this case, main purpose for above fixes tags is to provide back
> trace from document to the code,
> but adding 'stable' tag enables backporting this document patch to LTS
> release, which doesn't hurt, so please add stable tag too.
all right, many thanks for you.
> .
  

Patch

diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
index 7eac1b3c92..11d0c04884 100644
--- a/doc/guides/nics/hns3.rst
+++ b/doc/guides/nics/hns3.rst
@@ -30,7 +30,6 @@  Features of the HNS3 PMD are:
 - DCB
 - Scattered and gather for TX and RX
 - Vector Poll mode driver
-- Dump register
 - SR-IOV VF
 - Multi-process
 - MAC/VLAN filter
@@ -38,6 +37,15 @@  Features of the HNS3 PMD are:
 - NUMA support
 - Generic flow API
 - IEEE1588/802.1AS timestamping
+- Basic stats
+- Extended stats
+- Traffic Management API
+- Speed capabilities
+- Link Auto-negotiation
+- Link flow control
+- Dump register
+- Dump private info from device
+- FW version
 
 Prerequisites
 -------------