[dpdk-stable] [dpdk-dev] [PATCH v2] eventdev: fix doxygen comment

[Rao, Nikhil]

> -----Original Message-----
> From: jerinj at marvell.com [mailto:jerinj at marvell.com]
> Sent: Tuesday, July 2, 2019 12:16 PM
> To: dev at dpdk.org; Jerin Jacob <jerinj at marvell.com>
> Cc: stable at dpdk.org; Rao, Nikhil <nikhil.rao at intel.com>
> Subject: [dpdk-dev] [PATCH v2] eventdev: fix doxygen comment
> 
> From: Jerin Jacob <jerinj at marvell.com>
> 
> Update rte_eventdev.h file description to adapt to Tx adapter changes.
> 
> Fixes: c9bf83947e2e ("eventdev: add eth Tx adapter APIs")
> Cc: stable at dpdk.org
> Cc: Nikhil Rao <nikhil.rao at intel.com>
> 
> Signed-off-by: Jerin Jacob <jerinj at marvell.com>
> ---
> 
> v2:
> - Removed refference to rte_event_eth_tx_adapter_enqueue() API and
> made generic Tx adapter API to address
> RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT
> vs non RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT case(Nikhil)
> 
> ---
>  lib/librte_eventdev/rte_eventdev.h | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/lib/librte_eventdev/rte_eventdev.h
> b/lib/librte_eventdev/rte_eventdev.h
> index 517cd8083..927f43c24 100644
> --- a/lib/librte_eventdev/rte_eventdev.h
> +++ b/lib/librte_eventdev/rte_eventdev.h
> @@ -181,9 +181,8 @@
>   * 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 use Tx adapter API for
> + maintaining
> + * the ingress order and then send the packet/event on the wire.
>   *
>   * 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
Reviewed-by: Nikhil Rao <nikhil.rao at intel.com>