DPDK patches and discussions
 help / color / mirror / Atom feed
From: Stephen Hemminger <stephen@networkplumber.org>
To: Tyler Retzlaff <roretzla@linux.microsoft.com>
Cc: dev@dpdk.org
Subject: Re: [PATCH 0/2] remove unnecessary words in function documention
Date: Wed, 22 Jun 2022 13:54:46 -0700	[thread overview]
Message-ID: <20220622135446.0aa0e006@hermes.local> (raw)
In-Reply-To: <20220622203712.GC20387@linuxonhyperv3.guj3yctzbm1etfxqx2vob5hsef.xx.internal.cloudapp.net>

On Wed, 22 Jun 2022 13:37:12 -0700
Tyler Retzlaff <roretzla@linux.microsoft.com> wrote:

> 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).
> 

Doxygen repacks line during documentation generation

  reply	other threads:[~2022-06-22 20:54 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-22 20:27 Stephen Hemminger
2022-06-22 20:27 ` [PATCH 1/2] rawdev, dmadev: remove passive voice in function doc Stephen Hemminger
2022-06-23  0:30   ` 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 [this message]
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=20220622135446.0aa0e006@hermes.local \
    --to=stephen@networkplumber.org \
    --cc=dev@dpdk.org \
    --cc=roretzla@linux.microsoft.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).