[v3,2/6] doc: add link up/down feature

Message ID 20231125014745.61348-3-lihuisong@huawei.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series doc/features: fix some features and add new features |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

lihuisong (C) Nov. 25, 2023, 1:47 a.m. UTC
  Add link up/down feature for features.rst.

Fixes: 915e67837586 ("ethdev: API for link up and down")
Cc: stable@dpdk.org

Signed-off-by: Huisong Li <lihuisong@huawei.com>
Acked-by: Chengwen Feng <fengchengwen@huawei.com>
---
 doc/guides/nics/features.rst | 4 ++++
 1 file changed, 4 insertions(+)
  

Comments

Ferruh Yigit Nov. 27, 2023, 12:24 p.m. UTC | #1
On 11/25/2023 1:47 AM, Huisong Li wrote:
> Add link up/down feature for features.rst.
> 
> Fixes: 915e67837586 ("ethdev: API for link up and down")
> Cc: stable@dpdk.org
> 

Documentation is added after feature, so above fixes line is not correct.

I am not sure if this is fix, I think more like it is extending the
document.


With fixes line fix,
Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>


> Signed-off-by: Huisong Li <lihuisong@huawei.com>
> Acked-by: Chengwen Feng <fengchengwen@huawei.com>
> ---
>  doc/guides/nics/features.rst | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst
> index 0d38c5c525..f14962a6c3 100644
> --- a/doc/guides/nics/features.rst
> +++ b/doc/guides/nics/features.rst
> @@ -45,6 +45,10 @@ Supports getting the link speed, duplex mode and link state (up/down).
>  * **[implements] rte_eth_dev_data**: ``dev_link``.
>  * **[related]    API**: ``rte_eth_link_get()``, ``rte_eth_link_get_nowait()``.
>  
> +Set link up/down an Ethernet device.
> +
> +* **[implements] eth_dev_ops**: ``dev_set_link_up``, ``dev_set_link_down``.
> +* **[related]    API**: ``rte_eth_dev_set_link_up()``, ``rte_eth_dev_set_link_down()``.
>  
>  .. _nic_features_link_status_event:
>
  
lihuisong (C) Nov. 27, 2023, 1:16 p.m. UTC | #2
在 2023/11/27 20:24, Ferruh Yigit 写道:
> On 11/25/2023 1:47 AM, Huisong Li wrote:
>> Add link up/down feature for features.rst.
>>
>> Fixes: 915e67837586 ("ethdev: API for link up and down")
>> Cc: stable@dpdk.org
>>
> Documentation is added after feature, so above fixes line is not correct.
>
> I am not sure if this is fix, I think more like it is extending the
> document.
>
>
> With fixes line fix,
> Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>
>
Ok  just to add Cc stable.
>> Signed-off-by: Huisong Li <lihuisong@huawei.com>
>> Acked-by: Chengwen Feng <fengchengwen@huawei.com>
>> ---
>>   doc/guides/nics/features.rst | 4 ++++
>>   1 file changed, 4 insertions(+)
>>
>> diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst
>> index 0d38c5c525..f14962a6c3 100644
>> --- a/doc/guides/nics/features.rst
>> +++ b/doc/guides/nics/features.rst
>> @@ -45,6 +45,10 @@ Supports getting the link speed, duplex mode and link state (up/down).
>>   * **[implements] rte_eth_dev_data**: ``dev_link``.
>>   * **[related]    API**: ``rte_eth_link_get()``, ``rte_eth_link_get_nowait()``.
>>   
>> +Set link up/down an Ethernet device.
>> +
>> +* **[implements] eth_dev_ops**: ``dev_set_link_up``, ``dev_set_link_down``.
>> +* **[related]    API**: ``rte_eth_dev_set_link_up()``, ``rte_eth_dev_set_link_down()``.
>>   
>>   .. _nic_features_link_status_event:
>>   
>
> .
  

Patch

diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst
index 0d38c5c525..f14962a6c3 100644
--- a/doc/guides/nics/features.rst
+++ b/doc/guides/nics/features.rst
@@ -45,6 +45,10 @@  Supports getting the link speed, duplex mode and link state (up/down).
 * **[implements] rte_eth_dev_data**: ``dev_link``.
 * **[related]    API**: ``rte_eth_link_get()``, ``rte_eth_link_get_nowait()``.
 
+Set link up/down an Ethernet device.
+
+* **[implements] eth_dev_ops**: ``dev_set_link_up``, ``dev_set_link_down``.
+* **[related]    API**: ``rte_eth_dev_set_link_up()``, ``rte_eth_dev_set_link_down()``.
 
 .. _nic_features_link_status_event: