From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>,
Bruce Richardson <bruce.richardson@intel.com>,
Chengwen Feng <fengchengwen@huawei.com>,
Kevin Laatz <kevin.laatz@intel.com>
Subject: [PATCH 1/2] rawdev, dmadev: remove passive voice in function doc
Date: Wed, 22 Jun 2022 13:27:37 -0700 [thread overview]
Message-ID: <20220622202738.401690-2-stephen@networkplumber.org> (raw)
In-Reply-To: <20220622202738.401690-1-stephen@networkplumber.org>
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
--
2.35.1
next prev parent reply other threads:[~2022-06-22 20:27 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-22 20:27 [PATCH 0/2] remove unnecessary words in function documention Stephen Hemminger
2022-06-22 20:27 ` Stephen Hemminger [this message]
2022-06-23 0:30 ` [PATCH 1/2] rawdev, dmadev: remove passive voice in function doc fengchengwen
2022-06-23 8:40 ` Walsh, Conor
2022-06-22 20:27 ` [PATCH 2/2] eal: remove passive voice from interrupt function documentation Stephen Hemminger
2022-06-22 20:37 ` [PATCH 0/2] remove unnecessary words in function documention Tyler Retzlaff
2022-06-22 20:54 ` Stephen Hemminger
2022-06-23 4:57 ` Tyler Retzlaff
2022-06-24 12:06 ` David Marchand
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220622202738.401690-2-stephen@networkplumber.org \
--to=stephen@networkplumber.org \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=fengchengwen@huawei.com \
--cc=kevin.laatz@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.