diff mbox series

[RFC,3/4] doc: update prog guide to use rte_dma_op

Message ID 20250129143649.3887989-3-kshankar@marvell.com (mailing list archive)
State New
Delegated to: Thomas Monjalon
Headers
Series [RFC,1/4] dmadev: add enqueue dequeue operations |

Checks

Context Check Description
ci/checkpatch warning coding style issues

Commit Message

Kommula Shiva Shankar Jan. 29, 2025, 2:36 p.m. UTC 
From: Pavan Nikhilesh <pbhagavatula@marvell.com>

Update the documentation to replace all instances of
rte_event_dma_adapter_op with rte_dma_op

Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
Change-Id: I0fe65d18f4601709826c11c6738cacec8991515d
---
 doc/guides/prog_guide/eventdev/event_dma_adapter.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Amit Prakash Shukla Feb. 25, 2025, 2:13 p.m. UTC | #1 
> -----Original Message-----
> From: Kommula Shiva Shankar <kshankar@marvell.com>
> Sent: Wednesday, January 29, 2025 8:07 PM
> To: Jerin Jacob <jerinj@marvell.com>; Amit Prakash Shukla
> <amitprakashs@marvell.com>; Vamsi Krishna Attunuru
> <vattunuru@marvell.com>; fengchengwen@huawei.com; dev@dpdk.org
> Cc: Nithin Kumar Dabilpuram <ndabilpuram@marvell.com>; Pavan Nikhilesh
> Bhagavatula <pbhagavatula@marvell.com>
> Subject: [PATCH RFC 3/4] doc: update prog guide to use rte_dma_op
> 
> From: Pavan Nikhilesh <pbhagavatula@marvell.com>
> 
> Update the documentation to replace all instances of
> rte_event_dma_adapter_op with rte_dma_op
> 
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> Change-Id: I0fe65d18f4601709826c11c6738cacec8991515d
> ---
>  doc/guides/prog_guide/eventdev/event_dma_adapter.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 

Acked-by: Amit Prakash Shukla <amitprakashs@marvell.com>


> diff --git a/doc/guides/prog_guide/eventdev/event_dma_adapter.rst
> b/doc/guides/prog_guide/eventdev/event_dma_adapter.rst
> index e040d89e8b..e8437a3297 100644
> --- a/doc/guides/prog_guide/eventdev/event_dma_adapter.rst
> +++ b/doc/guides/prog_guide/eventdev/event_dma_adapter.rst
> @@ -144,7 +144,7 @@ on which it enqueues events towards the DMA
> adapter using ``rte_event_enqueue_bu
>     uint32_t cap;
>     int ret;
> 
> -   /* Fill in event info and update event_ptr with rte_event_dma_adapter_op
> */
> +   /* Fill in event info and update event_ptr with rte_dma_op */
>     memset(&ev, 0, sizeof(ev));
>     .
>     .
> @@ -244,11 +244,11 @@ Set event response information
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
>  In the ``RTE_EVENT_DMA_ADAPTER_OP_FORWARD`` /
> ``RTE_EVENT_DMA_ADAPTER_OP_NEW`` mode, -the application specifies the
> dmadev ID and vchan ID in ``struct rte_event_dma_adapter_op``
> +the application specifies the dmadev ID and vchan ID in ``struct
> +rte_dma_op``
>  and the event information (response information)  needed to enqueue an
> event after the DMA operation has completed.
>  The response information is specified in ``struct rte_event`` -and appended
> to the ``struct rte_event_dma_adapter_op``.
> +and appended to the ``struct rte_dma_op``.
> 
> 
>  Start the adapter instance
> --
> 2.43.0
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/eventdev/event_dma_adapter.rst b/doc/guides/prog_guide/eventdev/event_dma_adapter.rst
index e040d89e8b..e8437a3297 100644
--- a/doc/guides/prog_guide/eventdev/event_dma_adapter.rst
+++ b/doc/guides/prog_guide/eventdev/event_dma_adapter.rst
@@ -144,7 +144,7 @@  on which it enqueues events towards the DMA adapter using ``rte_event_enqueue_bu
    uint32_t cap;
    int ret;
 
-   /* Fill in event info and update event_ptr with rte_event_dma_adapter_op */
+   /* Fill in event info and update event_ptr with rte_dma_op */
    memset(&ev, 0, sizeof(ev));
    .
    .
@@ -244,11 +244,11 @@  Set event response information
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 In the ``RTE_EVENT_DMA_ADAPTER_OP_FORWARD`` / ``RTE_EVENT_DMA_ADAPTER_OP_NEW`` mode,
-the application specifies the dmadev ID and vchan ID in ``struct rte_event_dma_adapter_op``
+the application specifies the dmadev ID and vchan ID in ``struct rte_dma_op``
 and the event information (response information)
 needed to enqueue an event after the DMA operation has completed.
 The response information is specified in ``struct rte_event``
-and appended to the ``struct rte_event_dma_adapter_op``.
+and appended to the ``struct rte_dma_op``.
 
 
 Start the adapter instance