diff mbox series

[1/2] rawdev, dmadev: remove passive voice in function doc

Message ID 20220622202738.401690-2-stephen@networkplumber.org (mailing list archive)
State Accepted
Delegated to: David Marchand
Headers show
Series remove unnecessary words in function documention | expand

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Stephen Hemminger June 22, 2022, 8:27 p.m. UTC
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@networkplumber.org>
---
 drivers/raw/ioat/rte_ioat_rawdev.h | 2 +-
 lib/dmadev/rte_dmadev.h            | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

fengchengwen June 23, 2022, 12:30 a.m. UTC | #1
Acked-by: Chengwen Feng <fengchengwen@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@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
>
Walsh, Conor June 23, 2022, 8:40 a.m. UTC | #2
> 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@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().

I understand that this change was probably done like this to have the smallest diff,
but should these lines be rewrapped. Its minor anyway so it doesn't really matter
but it just looks strange to me the way it is.

With or without suggestion:
Acked-by: Conor Walsh <conor.walsh@intel.com>

>   *
>   * @param dev_id
> --
> 2.35.1
diff mbox series

Patch

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