Re: [PATCH 16/29] doc/guides: improve DMA sample app guide

fengchengwen
2026-01-19T00:47:22Z

On 1/15/2026 6:21 AM, Stephen Hemminger wrote:
> Improve the DMA sample application documentation:
> - use Tx/Rx instead of TX/RX per DPDK style
> - use "software" and "hardware" instead of SW/HW abbreviations
> - add missing articles and fix punctuation
> - use consistent option formatting with leading dash
> - fix grammatical errors throughout
>
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---
> doc/guides/sample_app_ug/dma.rst | 104 +++++++++++++++----------------
> 1 file changed, 52 insertions(+), 52 deletions(-)
>

...

> .. literalinclude:: ../../../examples/dma/dmafwd.c
> @@ -210,8 +210,8 @@ When using hardware copy each Rx queue of the port is assigned a DMA device
>
> The initialization of hardware device is done by ``rte_dma_configure()`` and
> ``rte_dma_vchan_setup()`` functions using the ``rte_dma_conf`` and
> -``rte_dma_vchan_conf`` structs. After configuration the device is started
> -using ``rte_dma_start()`` function. Each of the above operations is done in
> +``rte_dma_vchan_conf`` structs. After configuration, the device is started

The rte_dma_vchan_conf is used with rte_dma_vchan_setup()
So maybe we could only descript functions, e.g.
``rte_dma_vchan_setup()`` functions. After configuration, the device is started

with this fixed, please:
Acked-by: Chengwen Feng <fengchengwen@huawei.com>

> +using the ``rte_dma_start()`` function. Each of the above operations is done in
> ``configure_dmadev_queue()``.
>

...