diff mbox series

[v8,7/7] doc/eth_tx: update instance get API

Message ID 20220622165405.533042-7-ganapati.kundapura@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Jerin Jacob
Headers
Series [v8,1/7] eventdev/eth_rx: add adapter instance get API |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/github-robot: build success github build: passed
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-abi-testing warning Testing issues

Commit Message

Ganapati Kundapura June 22, 2022, 4:54 p.m. UTC 
  Added rte_event_eth_tx_adapter_instance_get() details.

Signed-off-by: Ganapati Kundapura <ganapati.kundapura@intel.com>
---
 doc/guides/prog_guide/event_ethernet_tx_adapter.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Naga Harish K, S V June 22, 2022, 5:30 p.m. UTC | #1 
Reviewed-by: Naga Harish K S V <s.v.naga.harish.k@intel.com>

> -----Original Message-----
> From: Kundapura, Ganapati <ganapati.kundapura@intel.com>
> Sent: Wednesday, June 22, 2022 10:24 PM
> To: dev@dpdk.org; jerinj@marvell.com; Jayatheerthan, Jay
> <jay.jayatheerthan@intel.com>; Naga Harish K, S V
> <s.v.naga.harish.k@intel.com>
> Subject: [PATCH v8 7/7] doc/eth_tx: update instance get API
> 
> Added rte_event_eth_tx_adapter_instance_get() details.
> 
> Signed-off-by: Ganapati Kundapura <ganapati.kundapura@intel.com>
> ---
>  doc/guides/prog_guide/event_ethernet_tx_adapter.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/doc/guides/prog_guide/event_ethernet_tx_adapter.rst
> b/doc/guides/prog_guide/event_ethernet_tx_adapter.rst
> index f80d226..dc3e6a1 100644
> --- a/doc/guides/prog_guide/event_ethernet_tx_adapter.rst
> +++ b/doc/guides/prog_guide/event_ethernet_tx_adapter.rst
> @@ -165,6 +165,12 @@ in struct ``rte_event_eth_tx_adapter_stats``. The
> counter values are the sum of  the counts from the eventdev PMD callback if
> the callback is supported, and  the counts maintained by the service function,
> if one exists.
> 
> +Getting Adapter instance id
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +The  ``rte_event_eth_tx_adapter_instanceget()`` function reports tx
> +adapter instance id for a specified ethernet device id and tx queue index.
> +
>  Tx event vectorization
>  ~~~~~~~~~~~~~~~~~~~~~~
> 
> --
> 2.6.4
Jayatheerthan, Jay June 22, 2022, 5:41 p.m. UTC | #2 
> -----Original Message-----
> From: Kundapura, Ganapati <ganapati.kundapura@intel.com>
> Sent: Wednesday, June 22, 2022 10:24 PM
> To: dev@dpdk.org; jerinj@marvell.com; Jayatheerthan, Jay <jay.jayatheerthan@intel.com>; Naga Harish K, S V
> <s.v.naga.harish.k@intel.com>
> Subject: [PATCH v8 7/7] doc/eth_tx: update instance get API
> 
> Added rte_event_eth_tx_adapter_instance_get() details.
> 
> Signed-off-by: Ganapati Kundapura <ganapati.kundapura@intel.com>
> ---
>  doc/guides/prog_guide/event_ethernet_tx_adapter.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/doc/guides/prog_guide/event_ethernet_tx_adapter.rst b/doc/guides/prog_guide/event_ethernet_tx_adapter.rst
> index f80d226..dc3e6a1 100644
> --- a/doc/guides/prog_guide/event_ethernet_tx_adapter.rst
> +++ b/doc/guides/prog_guide/event_ethernet_tx_adapter.rst
> @@ -165,6 +165,12 @@ in struct ``rte_event_eth_tx_adapter_stats``. The counter values are the sum of
>  the counts from the eventdev PMD callback if the callback is supported, and
>  the counts maintained by the service function, if one exists.
> 
> +Getting Adapter instance id
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +The  ``rte_event_eth_tx_adapter_instanceget()`` function reports

Nitpick: rte_event_eth_tx_adapter_instanceget -> rte_event_eth_tx_adapter_instance_get.

With this change you can include Acked-by: Jay Jayatheerthan <jay.jayatheerthan@intel.com>

> +tx adapter instance id for a specified ethernet device id and tx queue index.
> +
>  Tx event vectorization
>  ~~~~~~~~~~~~~~~~~~~~~~
> 
> --
> 2.6.4
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/event_ethernet_tx_adapter.rst b/doc/guides/prog_guide/event_ethernet_tx_adapter.rst
index f80d226..dc3e6a1 100644
--- a/doc/guides/prog_guide/event_ethernet_tx_adapter.rst
+++ b/doc/guides/prog_guide/event_ethernet_tx_adapter.rst
@@ -165,6 +165,12 @@  in struct ``rte_event_eth_tx_adapter_stats``. The counter values are the sum of
 the counts from the eventdev PMD callback if the callback is supported, and
 the counts maintained by the service function, if one exists.
 
+Getting Adapter instance id
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The  ``rte_event_eth_tx_adapter_instanceget()`` function reports
+tx adapter instance id for a specified ethernet device id and tx queue index.
+
 Tx event vectorization
 ~~~~~~~~~~~~~~~~~~~~~~