From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 89DECA0545;
	Thu, 23 Jun 2022 06:57:58 +0200 (CEST)
Received: from [217.70.189.124] (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id 1D9F44069D;
	Thu, 23 Jun 2022 06:57:58 +0200 (CEST)
Received: from linux.microsoft.com (linux.microsoft.com [13.77.154.182])
 by mails.dpdk.org (Postfix) with ESMTP id 369A04069C
 for <dev@dpdk.org>; Thu, 23 Jun 2022 06:57:57 +0200 (CEST)
Received: by linux.microsoft.com (Postfix, from userid 1086)
 id 4D05A20C63CC; Wed, 22 Jun 2022 21:57:56 -0700 (PDT)
DKIM-Filter: OpenDKIM Filter v2.11.0 linux.microsoft.com 4D05A20C63CC
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.microsoft.com;
 s=default; t=1655960276;
 bh=Kcsq/exiID4OL66L7q8h2Bz/Nop7xbE6kOB27o/vnk0=;
 h=Date:From:To:Cc:Subject:References:In-Reply-To:From;
 b=p5uWEZ+ckY/Ztw8OLOL5wh/BpWirUr09oz64/GIkDTHCGQ9yUwwEGYnr+XlboLTsx
 ZJcs1j/rYK9sGwT23jK4ly6015tmJt6miMHzj8pkmST8Pm5nqc4cloRnH98MnssWtF
 WZpJnAC3S4BbnPMiWnbQ266FDtUPj2LgDlYwY4MM=
Date: Wed, 22 Jun 2022 21:57:56 -0700
From: Tyler Retzlaff <roretzla@linux.microsoft.com>
To: Stephen Hemminger <stephen@networkplumber.org>
Cc: dev@dpdk.org
Subject: Re: [PATCH 0/2] remove unnecessary words in function documention
Message-ID: <20220623045756.GA19847@linuxonhyperv3.guj3yctzbm1etfxqx2vob5hsef.xx.internal.cloudapp.net>
References: <20220622202738.401690-1-stephen@networkplumber.org>
 <20220622203712.GC20387@linuxonhyperv3.guj3yctzbm1etfxqx2vob5hsef.xx.internal.cloudapp.net>
 <20220622135446.0aa0e006@hermes.local>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20220622135446.0aa0e006@hermes.local>
User-Agent: Mutt/1.5.21 (2010-09-15)
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org

On Wed, Jun 22, 2022 at 01:54:46PM -0700, Stephen Hemminger wrote:
> 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

no worries either way, myself i don't read doxygen i read the
code/comments directly.