[PATCH 1/2] rawdev, dmadev: remove passive voice in function doc
fengchengwen
fengchengwen at huawei.com
Thu Jun 23 02:30:17 CEST 2022
Acked-by: Chengwen Feng <fengchengwen at huawei.com>
On 2022/6/23 4:27, Stephen Hemminger wrote:
> Remove extraneous phrase "This API is used to" and use
> active instead of passive voice when describing a function.
>
> Signed-off-by: Stephen Hemminger <stephen at networkplumber.org>
> ---
> drivers/raw/ioat/rte_ioat_rawdev.h | 2 +-
> lib/dmadev/rte_dmadev.h | 2 +-
> 2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/raw/ioat/rte_ioat_rawdev.h b/drivers/raw/ioat/rte_ioat_rawdev.h
> index 6cc1560a6402..0e79f754723d 100644
> --- a/drivers/raw/ioat/rte_ioat_rawdev.h
> +++ b/drivers/raw/ioat/rte_ioat_rawdev.h
> @@ -123,7 +123,7 @@ rte_ioat_fence(int dev_id);
> /**
> * Trigger hardware to begin performing enqueued operations
> *
> - * This API is used to write the "doorbell" to the hardware to trigger it
> + * Writes the "doorbell" to the hardware to trigger it
> * to begin the operations previously enqueued by rte_ioat_enqueue_copy()
> *
> * @param dev_id
> diff --git a/lib/dmadev/rte_dmadev.h b/lib/dmadev/rte_dmadev.h
> index a7081e633c2a..e7f992b734fc 100644
> --- a/lib/dmadev/rte_dmadev.h
> +++ b/lib/dmadev/rte_dmadev.h
> @@ -970,7 +970,7 @@ rte_dma_fill(int16_t dev_id, uint16_t vchan, uint64_t pattern,
> *
> * Trigger hardware to begin performing enqueued operations.
> *
> - * This API is used to write the "doorbell" to the hardware to trigger it
> + * Writes the "doorbell" to the hardware to trigger it
> * to begin the operations previously enqueued by rte_dma_copy/fill().
> *
> * @param dev_id
>
More information about the dev
mailing list