diff mbox series

eventdev: fix doxygen comment

Message ID 20190619080309.32188-1-jerinj@marvell.com (mailing list archive)
State Superseded, archived
Delegated to: Jerin Jacob
Headers
Series eventdev: fix doxygen comment |

Checks

Context Check Description
ci/intel-Performance-Testing success Performance Testing PASS
ci/mellanox-Performance-Testing success Performance Testing PASS
ci/checkpatch success coding style OK
ci/Intel-compilation fail Compilation issues

Commit Message

Jerin Jacob Kollanukkaran June 19, 2019, 8:03 a.m. UTC 
  From: Jerin Jacob <jerinj@marvell.com>

Update rte_eventdev.h file description to adapt to Tx adapter changes.

Fixes: c9bf83947e2e ("eventdev: add eth Tx adapter APIs")
Cc: stable@dpdk.org
Cc: Nikhil Rao <nikhil.rao@intel.com>

Signed-off-by: Jerin Jacob <jerinj@marvell.com>
---
 lib/librte_eventdev/rte_eventdev.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Rao, Nikhil June 24, 2019, 6:13 a.m. UTC | #1 
Hi Jerin,

> -----Original Message-----
> From: jerinj@marvell.com [mailto:jerinj@marvell.com]
> Sent: Wednesday, June 19, 2019 1:33 PM
> To: dev@dpdk.org; Jerin Jacob <jerinj@marvell.com>
> Cc: stable@dpdk.org; Rao, Nikhil <nikhil.rao@intel.com>
> Subject: [dpdk-dev] [PATCH] eventdev: fix doxygen comment
> 
> From: Jerin Jacob <jerinj@marvell.com>
> 
> Update rte_eventdev.h file description to adapt to Tx adapter changes.
> 
> Fixes: c9bf83947e2e ("eventdev: add eth Tx adapter APIs")
> Cc: stable@dpdk.org
> Cc: Nikhil Rao <nikhil.rao@intel.com>
> 
> Signed-off-by: Jerin Jacob <jerinj@marvell.com>
> ---
>  lib/librte_eventdev/rte_eventdev.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/lib/librte_eventdev/rte_eventdev.h
> b/lib/librte_eventdev/rte_eventdev.h
> index 517cd8083..a5ec5d99b 100644
> --- a/lib/librte_eventdev/rte_eventdev.h
> +++ b/lib/librte_eventdev/rte_eventdev.h
> @@ -181,9 +181,9 @@
>   * The *dequeue* operation gets one or more events from the event ports.
>   * The application process the events and send to downstream event queue
> through
>   * rte_event_enqueue_burst() if it is an intermediate stage of event
> processing,
> - * on the final stage, the application may send to different subsystem like
> - * ethdev to send the packet/event on the wire using ethdev
> - * rte_eth_tx_burst() API.
> + * on the final stage, the application may send to Tx adapter for
> maintaining
> + * the ingress order and then to send the packet/event on the wire using
> + * rte_event_eth_tx_adapter_enqueue() API.

Since the change above is applicable only if  eventdev supports the RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT, can we rephrase to include both cases ?  The Tx adapter documentation has the details, it would be good to cross reference it.

Thanks,
Nikhil

>   *
>   * The point at which events are scheduled to ports depends on the device.
>   * For hardware devices, scheduling occurs asynchronously without any
> software
> --
> 2.21.0
diff mbox series

Patch

diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
index 517cd8083..a5ec5d99b 100644
--- a/lib/librte_eventdev/rte_eventdev.h
+++ b/lib/librte_eventdev/rte_eventdev.h
@@ -181,9 +181,9 @@ 
  * The *dequeue* operation gets one or more events from the event ports.
  * The application process the events and send to downstream event queue through
  * rte_event_enqueue_burst() if it is an intermediate stage of event processing,
- * on the final stage, the application may send to different subsystem like
- * ethdev to send the packet/event on the wire using ethdev
- * rte_eth_tx_burst() API.
+ * on the final stage, the application may send to Tx adapter for maintaining
+ * the ingress order and then to send the packet/event on the wire using
+ * rte_event_eth_tx_adapter_enqueue() API.
  *
  * The point at which events are scheduled to ports depends on the device.
  * For hardware devices, scheduling occurs asynchronously without any software