ethdev: fix incorrect function name in comment

Message ID 20231020130556.37242-1-bruce.richardson@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series ethdev: fix incorrect function name in comment |

Checks

Context Check Description
ci/loongarch-compilation success Compilation OK
ci/checkpatch success coding style OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/github-robot: build success github build: passed
ci/intel-Functional success Functional PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS

Commit Message

Bruce Richardson Oct. 20, 2023, 1:05 p.m. UTC
  For those using the function comments as a guide, provide the name of
the correct callback function to use when wanting to count dropped
packets from the ethdev tx buffering system.

Fixes: d6c99e62c852 ("ethdev: add buffered Tx")
Cc: stable@dpdk.org

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 lib/ethdev/rte_ethdev.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Ferruh Yigit Oct. 20, 2023, 3:12 p.m. UTC | #1
On 10/20/2023 2:05 PM, Bruce Richardson wrote:
> For those using the function comments as a guide, provide the name of
> the correct callback function to use when wanting to count dropped
> packets from the ethdev tx buffering system.
> 
> Fixes: d6c99e62c852 ("ethdev: add buffered Tx")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> 

Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>
  
lihuisong (C) Oct. 21, 2023, 4:10 a.m. UTC | #2
在 2023/10/20 23:12, Ferruh Yigit 写道:
> On 10/20/2023 2:05 PM, Bruce Richardson wrote:
>> For those using the function comments as a guide, provide the name of
>> the correct callback function to use when wanting to count dropped
>> packets from the ethdev tx buffering system.
>>
>> Fixes: d6c99e62c852 ("ethdev: add buffered Tx")
>> Cc: stable@dpdk.org
>>
>> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
>>
> Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>

correct, rte_eth_count_unsent_packet_callback is not even exist.

Acked-by: Huisong Li <lihuisong@huawei.com>

>
> .
  
Ferruh Yigit Oct. 26, 2023, 3:23 p.m. UTC | #3
On 10/21/2023 5:10 AM, lihuisong (C) wrote:
> 
> 在 2023/10/20 23:12, Ferruh Yigit 写道:
>> On 10/20/2023 2:05 PM, Bruce Richardson wrote:
>>> For those using the function comments as a guide, provide the name of
>>> the correct callback function to use when wanting to count dropped
>>> packets from the ethdev tx buffering system.
>>>
>>> Fixes: d6c99e62c852 ("ethdev: add buffered Tx")
>>> Cc: stable@dpdk.org
>>>
>>> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
>>>
>> Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>
> 
> correct, rte_eth_count_unsent_packet_callback is not even exist.
> 
> Acked-by: Huisong Li <lihuisong@huawei.com>
> 

Applied to dpdk-next-net/main, thanks.
  

Patch

diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index 85b9af7a02..2fd3cd808d 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -3732,7 +3732,7 @@  rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
  * for example, to count dropped packets, or to retry transmission of packets
  * which cannot be sent, this function should be used to register a suitable
  * callback function to implement the desired behaviour.
- * The example callback "rte_eth_count_unsent_packet_callback()" is also
+ * The example callback "rte_eth_tx_buffer_count_callback()" is also
  * provided as reference.
  *
  * @param buffer