[PATCH 0/2] remove unnecessary words in function documention
Tyler Retzlaff
roretzla at linux.microsoft.com
Wed Jun 22 22:37:12 CEST 2022
On Wed, Jun 22, 2022 at 01:27:36PM -0700, Stephen Hemminger wrote:
> The phrase "This API is used to" is unnecessary and changes the
> documentation into passive voice.
>
> Stephen Hemminger (2):
> rawdev, dmadev: remove passive voice in function doc
> eal: remove passive voice from interrupt function documentation
>
> drivers/raw/ioat/rte_ioat_rawdev.h | 2 +-
> lib/dmadev/rte_dmadev.h | 2 +-
> lib/eal/include/rte_interrupts.h | 23 +++++++++++------------
> 3 files changed, 13 insertions(+), 14 deletions(-)
>
> --
the re-wording has shortened some of the lines, i'm not sure what
takes precedence (minimum diff vs line length convention).
whatever is decided lgtm
Series-acked-by: Tyler Retzlaff <roretzla at linux.microsoft.com>
More information about the dev
mailing list