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 2D431A0093;
	Thu, 23 Jun 2022 10:40:35 +0200 (CEST)
Received: from [217.70.189.124] (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id BF5FE4069D;
	Thu, 23 Jun 2022 10:40:34 +0200 (CEST)
Received: from mga14.intel.com (mga14.intel.com [192.55.52.115])
 by mails.dpdk.org (Postfix) with ESMTP id 686134067B
 for <dev@dpdk.org>; Thu, 23 Jun 2022 10:40:32 +0200 (CEST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple;
 d=intel.com; i=@intel.com; q=dns/txt; s=Intel;
 t=1655973632; x=1687509632;
 h=from:to:cc:subject:date:message-id:references:
 in-reply-to:content-transfer-encoding:mime-version;
 bh=PObSjyYgb09V0PjabFlERgwsnHHVQwa/v4mbHyg74rY=;
 b=fX8tc+2hD5Q3kawFZXqzSWuW3Oc30VzozeTuKQAzs0tifIdoYs9HigsV
 6uuuOssfli9GErNLYbNo9clbAuYmM1Or+0s0apaw2DR12pl8kCrtBKJhn
 vR762p6++AgDkv5yGdjlwvY5lDzxn1xWdJgj++xc1zcEvKWAnELF5bZqI
 TMA3LSNTvzE7DTAVTmrGIUHnYWTGYUZKrsOC8sfan1e+vHDkPCl77pFMS
 5z2uvx+WhgRsE67J9Y622EhyL7Pxiwoj1k4pr+U0uqonCoQSC1JIN018q
 v7+3RJq8c7khiNCRrP90VicsH3/cVckTiH+dtm4SR/WHErN2jpkySgiog Q==;
X-IronPort-AV: E=McAfee;i="6400,9594,10386"; a="280710092"
X-IronPort-AV: E=Sophos;i="5.92,215,1650956400"; d="scan'208";a="280710092"
Received: from orsmga007.jf.intel.com ([10.7.209.58])
 by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
 23 Jun 2022 01:40:19 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.92,215,1650956400"; d="scan'208";a="586079455"
Received: from fmsmsx604.amr.corp.intel.com ([10.18.126.84])
 by orsmga007.jf.intel.com with ESMTP; 23 Jun 2022 01:40:18 -0700
Received: from fmsmsx612.amr.corp.intel.com (10.18.126.92) by
 fmsmsx604.amr.corp.intel.com (10.18.126.84) with Microsoft SMTP Server
 (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id
 15.1.2308.27; Thu, 23 Jun 2022 01:40:18 -0700
Received: from fmsedg602.ED.cps.intel.com (10.1.192.136) by
 fmsmsx612.amr.corp.intel.com (10.18.126.92) with Microsoft SMTP Server
 (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id
 15.1.2308.27 via Frontend Transport; Thu, 23 Jun 2022 01:40:18 -0700
Received: from NAM11-DM6-obe.outbound.protection.outlook.com (104.47.57.169)
 by edgegateway.intel.com (192.55.55.71) with Microsoft SMTP Server
 (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id
 15.1.2308.27; Thu, 23 Jun 2022 01:40:17 -0700
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none;
 b=irSQ3g9pAAVNXOy9J9tpzyoQhTdwXbnMcjCLix6yPjZbbXrI64DX6HMElWtI8UzwqRYsYOFte0PWBQZdJh1sLBuWhFQBT6AE5q4HfIM328KzjLbiJQHjw8jebqb0o51PqczrkLRgqrfi4YavqrbBKtz4hfxVIUzZlWu7Bg5V1i4ZZ+8CC3Q2qo4qv1mYyixgXHn28s70dg2krg6UVNqkxQPTLdh9vKD65uGgyO/93Amuldd+ySFDufjxMJE6XiGGwynIxrWzdbKdh4yUJAiXi3yVJ/q0CXvGwKE7jRc6bLdXUuK9Tcy4gbx8jEkxO4ZqylwrPaZP21FWHrozbwhN1A==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; 
 s=arcselector9901;
 h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1;
 bh=ai62DfPVuYOAcoJSLjHkjiG8gtQUEm0TBxSDWWOaC+o=;
 b=EaEa2vfKOg/zQuSI5y9tkFyUXiKdznzj8Nsl/QKVToYkAUefFHnjY39aLTJV9OYegre01wZ8U+iwNW4qOiLsntLMj+W/qb7uHhkAynhs/WIrnLeiVzkbWwPNxKZ5v70pp5IlatvI2To+FxByhvPk03j3Nhru3DZ6swOv12Gc3mAVXvPpeZXljtsG4zLQBm1ZrZgxLnI9TxXasnY69uuE9RKaHxk+WxZbjsmKnil/n/mtE2E19v7uoHM5A3Kro8vdtQ7t6b5CKSsZwo2ORszgwkJ8447I+Ozg9g48Pk1w0L/QeFdttGSMtnTPjzazixrx+GZzZ134T3t/b4ZWCkEd2g==
ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass
 smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com;
 dkim=pass header.d=intel.com; arc=none
Received: from PH0PR11MB5207.namprd11.prod.outlook.com (2603:10b6:510:32::15)
 by SA2PR11MB4956.namprd11.prod.outlook.com (2603:10b6:806:112::20)
 with Microsoft SMTP Server (version=TLS1_2,
 cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5373.15; Thu, 23 Jun
 2022 08:40:16 +0000
Received: from PH0PR11MB5207.namprd11.prod.outlook.com
 ([fe80::b57b:e805:bd34:bde9]) by PH0PR11MB5207.namprd11.prod.outlook.com
 ([fe80::b57b:e805:bd34:bde9%7]) with mapi id 15.20.5373.015; Thu, 23 Jun 2022
 08:40:16 +0000
From: "Walsh, Conor" <conor.walsh@intel.com>
To: Stephen Hemminger <stephen@networkplumber.org>, "dev@dpdk.org"
 <dev@dpdk.org>
CC: "Richardson, Bruce" <bruce.richardson@intel.com>, Chengwen Feng
 <fengchengwen@huawei.com>, "Laatz, Kevin" <kevin.laatz@intel.com>
Subject: RE: [PATCH 1/2] rawdev, dmadev: remove passive voice in function doc
Thread-Topic: [PATCH 1/2] rawdev, dmadev: remove passive voice in function doc
Thread-Index: AQHYhnaaAVULfYYapEeGGbkXgvcFyq1cq1dA
Date: Thu, 23 Jun 2022 08:40:16 +0000
Message-ID: <PH0PR11MB52078DCF45D7423A54F77019FFB59@PH0PR11MB5207.namprd11.prod.outlook.com>
References: <20220622202738.401690-1-stephen@networkplumber.org>
 <20220622202738.401690-2-stephen@networkplumber.org>
In-Reply-To: <20220622202738.401690-2-stephen@networkplumber.org>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach: 
X-MS-TNEF-Correlator: 
dlp-reaction: no-action
dlp-version: 11.6.500.17
dlp-product: dlpe-windows
authentication-results: dkim=none (message not signed)
 header.d=none;dmarc=none action=none header.from=intel.com;
x-ms-publictraffictype: Email
x-ms-office365-filtering-correlation-id: c3d552a3-289f-46ad-feef-08da54f3ff73
x-ms-traffictypediagnostic: SA2PR11MB4956:EE_
x-ld-processed: 46c98d88-e344-4ed4-8496-4ed7712e255d,ExtAddr
x-microsoft-antispam-prvs: <SA2PR11MB49567668BC935949DA2F0B7FFFB59@SA2PR11MB4956.namprd11.prod.outlook.com>
x-ms-exchange-senderadcheck: 1
x-ms-exchange-antispam-relay: 0
x-microsoft-antispam: BCL:0;
x-microsoft-antispam-message-info: qIxseeIEn734OjmC+nVuQcJ9g9BxFBV9brx2ubR09MKl2nbZYsZ/zIBCKAqqo6WMtqyKUYxlOGPRXUsLD74kH8JUwDd6NMm2bcPttUjVjQI7U3kzNc0wVAvbnaGEUxEJmE0UfxsaxJXH54Wh3dBP7d0Kjx9bsE5oG2l11It9u38y3u4T60HDK3jXRyFrfe0kSy9UmG+1wBsK+LwAWiUWntY28Gy2MxLMMm9mG9V02JqUUMW4FSqB5UFQZvgoonqlowlXAykw18uRhSoeVKt5EYXAdzHPaupKYRkN/6acq2rDuadWGsztkQaSEOheeajJqYnRR2mNPhtLzDQlDIL9qzZr/YbEYdibDzDLtyGr4D0GgHL9/fhf+FLiHUEJoXeBnVRE4ehZ/ETtEX9WqWiP0KHAHoZKTxLN0UsTwpZzj7X/7mbbCECloip96KGLZgd0TRt126RWt19eHd6TLoqvCn+HHiQNRSCl27DmusAWa0Ly4w28JAiAWc+1AKOqEQqYmasU2kw1rhDKAM3x0M51BW9B+MRn3X357bKr2/UL0Th2CgpZQFHwc6qBnTQ9PNthPRzjQ4Id0WMCVY2XbGWJI2tAR2AhW/APs088Ku8q0D9KAvLnLAG/V19MvSxoMWLaktRXXmNsESL/qoFYOzI6lIqSbDo0Z7y3rq/Ufi7mlPs+7iozIc2MK3vZydw9uzyUiyyQIk27DcBmGNvEQlzktBZn0wCLeDu0ytqpboEAqh0ecjJ3d97sMiWMpP4xVW5k8pA8WONCzGIexk7dccJX+A==
x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:;
 IPV:NLI; SFV:NSPM; H:PH0PR11MB5207.namprd11.prod.outlook.com; PTR:; CAT:NONE;
 SFS:(13230016)(376002)(136003)(346002)(39860400002)(396003)(366004)(66476007)(478600001)(4326008)(52536014)(66446008)(5660300002)(83380400001)(55016003)(66556008)(64756008)(66946007)(71200400001)(8936002)(8676002)(76116006)(33656002)(9686003)(82960400001)(122000001)(26005)(38070700005)(38100700002)(107886003)(86362001)(2906002)(6506007)(54906003)(186003)(41300700001)(7696005)(316002)(110136005);
 DIR:OUT; SFP:1102; 
x-ms-exchange-antispam-messagedata-chunkcount: 1
x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?6du46yiFabaAPLHJ0EvR8LOaiK4vF56YSKizMPT5AssobraI6ZOdZIUQ33Sd?=
 =?us-ascii?Q?6YOvPK49SrGlUCG/Qm+ZgdBEKS+Z0ctPHTUT4TrPHj7qhnE6JPz2VEIZKL8k?=
 =?us-ascii?Q?zPiSCAFblDq6j0ITnnpRfYesXbFVYvWOizv9+K3TRF8Zwc7sBA+VoYUZuojS?=
 =?us-ascii?Q?XTR4vsXEwZyXQV6E3iNAXcsPgq/x7O214RtgKb+SuIzgtiqUmymyaY9nDyHD?=
 =?us-ascii?Q?dNKNdN0omuAPXAsgN/4ev1yQzsffUTzLwWuQDpgSLm7OlG2UfWfISzK+3eWk?=
 =?us-ascii?Q?EoZOoyNQCRocC4GKPr3uCncac8VIzt1DJ0EPuat7Ff8pbfcQ+nVZ/fjgBqG0?=
 =?us-ascii?Q?0rwyc4Lu0fMaxcUw7zNoFrXdmJLHaxZHw1GridS4h2DN9EPKKdLeDgHCMETX?=
 =?us-ascii?Q?p6cKvMwChi3/JiIJ7AK89hcA/I8ko438kdxfoKYPtXqC8n+0gXkpxtwodeJz?=
 =?us-ascii?Q?GioFd1+i3l0OTgPfrENaIxEDa8hW13sWJLG+bKHWhmEQhRlNmAZCTw4sQ+mI?=
 =?us-ascii?Q?oMYeVy+nwxeclsCTgyZwC5365ZKfbp5JUHU4OnjgDNM/a7WmiaMyGiaHjklD?=
 =?us-ascii?Q?Wc2KyB4lt2tXxpqe6QvHMnEB84wjtieKXQ+2zw/p6oAsiLviAd0Ph2HCanLn?=
 =?us-ascii?Q?lCMPKjj8nJwrErj5jrdiP/iL+vORzSmbFOncmUtOC1qmI291Pezeo78PRU2+?=
 =?us-ascii?Q?FxjEH7r+t9Nbdtw96KOqftghi5m2X9ZuT7lQOm6P0+6IQBTHC2KZOnwi9xgP?=
 =?us-ascii?Q?tXekqQHh+XUr5QZbJP+GsRdg9xHA0ljFJxxGVJ4ZkvSU9Q0znyREabDtbCfc?=
 =?us-ascii?Q?Kl5qVqnrWUxVcLAp0A2OiVor2FZLnKlUxbbAsBgL/GAGh1k6q4GpL2yMpkwF?=
 =?us-ascii?Q?eUzynjJ7GvIWztS8F14nm6M2XBsValMIgDke8fWBTPqorWv7ZVADgUmWsSKi?=
 =?us-ascii?Q?uC7G3sb2/xJwkH6eiskVB0/t5NsH8kfuk3Uxt3ydqp6qPXQbGUm6UVkQUOT5?=
 =?us-ascii?Q?HCSd6kA2feufw+JCXZKxstxP8ft4oLJRSwnu6OFyr7QTQYZjOObcd9JqS5rT?=
 =?us-ascii?Q?XY/ssw7zz54fKrzieEzrraExRim3oXcqdFuYkmyo47FoTPtTAGhokUM8dJ+O?=
 =?us-ascii?Q?HmGSaJjGj1/64ITsDfWRpPekqpezyvIT8sa4dXUfmDkiUXwpId9m6PYTfrMQ?=
 =?us-ascii?Q?VVJYoiD7zlhoLRspkZMtFp8Kk3UdY5xVSR6r4vLxPGulthKMHghmaNc2C9wn?=
 =?us-ascii?Q?wNBhEPv7dpLM7l/2qy6M62M0ZGU34ZTR3MbJn6VkalS5GZWRKw4FcKw8jX/Z?=
 =?us-ascii?Q?v8jV5TtFOIDAiRNwExrfhEA8EB83nQlU/EQJbcfAgyR24MpmD1n2/SjZFJ6G?=
 =?us-ascii?Q?MDN8OyxrdFw0lk47h6nypmgM6FguZXQOoG1zm8STu4OH9Vtoi0w3Bbf7vfgF?=
 =?us-ascii?Q?dQ6eQa5YSPhgGsJTVZEoOAgE2Cuq5TBKlhAMuOWoJZU7ROJ49IGDcFQVgH0P?=
 =?us-ascii?Q?Ch7y0p40qqo4eDh9z65fYTGGQGSCYFmU454XPGXZb0q9bWt6C7yuRjWzoAB3?=
 =?us-ascii?Q?g3MFOf7wth51c6wWqoqRjeCxdqZ0iGWJG9uR95JPADaKJ/6P7SzibZLX6ORY?=
 =?us-ascii?Q?KOYq2EX1tfQVol1doly72qDkLRod0PqdB3GewtpDIwZfQ1MbF7w8NjL6XXOP?=
 =?us-ascii?Q?o1okVXH0OpMGQdRsLd8a5wUIk6JvBxkaZCSoZoDH0Cixh6m4Pwf59fC5J6y8?=
 =?us-ascii?Q?8N3QfwPB1g=3D=3D?=
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-AuthSource: PH0PR11MB5207.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: c3d552a3-289f-46ad-feef-08da54f3ff73
X-MS-Exchange-CrossTenant-originalarrivaltime: 23 Jun 2022 08:40:16.5455 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: tQLIf5zYMvW/rHAAx/aceio3iFc1PYtf4Y2iC4isTTYSp22khryErP5q2HLk2ETl8wRW5k/kJ1Fo4GbWHCEafw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA2PR11MB4956
X-OriginatorOrg: intel.com
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

> Remove extraneous phrase "This API is used to" and use
> active instead of passive voice when describing a function.
>=20
> 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(-)
>=20
> 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 i=
t
> + * 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 i=
t
> + * 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 small=
est 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