| Message ID | 20220622202738.401690-1-stephen@networkplumber.org (mailing list archive) |
|---|---|
| Headers |
Return-Path: <dev-bounces@dpdk.org> X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id DA86AA034C; Wed, 22 Jun 2022 22:27:43 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id CBC3D427F1; Wed, 22 Jun 2022 22:27:43 +0200 (CEST) Received: from mail-pg1-f175.google.com (mail-pg1-f175.google.com [209.85.215.175]) by mails.dpdk.org (Postfix) with ESMTP id C3B02427F3 for <dev@dpdk.org>; Wed, 22 Jun 2022 22:27:42 +0200 (CEST) Received: by mail-pg1-f175.google.com with SMTP id r66so11173929pgr.2 for <dev@dpdk.org>; Wed, 22 Jun 2022 13:27:42 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20210112.gappssmtp.com; s=20210112; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=UrXMRcYP/xM3M3kWrtvWXcDgV7Ahhq4vj3Rwdd46yFs=; b=NPuuU2JT0iL2TH/sXQ8q7J0aMv04A18ectWpr+4W+PcroBgpAov+kg64nX2VdEmu1a CZm9074AViUZz7tHSiYENvAT2EQMbRn2rxhgqMptxhPTB/qQljmGQVACTb/VSgqCGnRa hwbvFpf15Z+yq/7p3CVm330jRNxaCyGhinR2GIIclF/lEf/mgXD8pVcNYna38mFBLUrb 13O2uN7UFdiC+3QC7peh1ubKCJCzIDua8rlB0d2WuA8KrtPVYTsWhGms8D9LfUnygo5J mImGT86BI/vZY3APcY63ApKIP23pJ2iQecfRY3socWOyxB4Cq5tqR3SAlYrsMOw09bcl /WJw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=UrXMRcYP/xM3M3kWrtvWXcDgV7Ahhq4vj3Rwdd46yFs=; b=qWudRKUpdCVw9JcPF0GlsjfgevG3yEj/wH2aHdD9I4S/GVepFLu/uXlYBbnenrJUBb /OEm679lkTXtdd+jN1anZ68osvhfDAV11jDGKszUj+VuC4VIfaszpGOFxPnJ9vWveY8v TVuW4kdqFgX9b1eCI610gcwC//YAPPN70yNnDhwoYcoGxCUHPX6QVpBOLDUjGU3BmQpg K8zA9RnZVrhfSmTiUea0XBEVaNITNqo9E7rMuDz8Py/t5t8oLJYTQZjZG62eVisnHA+t wWFS3G7cMHr7Y0ORUYXsR3uLUKjvwFJkIW+BebX42O6yWtaP2Azyh9DqVR3kthEsAVZB sL4A== X-Gm-Message-State: AJIora9ER11HFD5UFcoCoZ2GQ2lsjE57i/BOkKzq+SrOwEfe1m2J3bcd V8iBvyI+Q8Le25F1qFbXNHbbOjVScdkClCkx X-Google-Smtp-Source: AGRyM1s4le4Skpbz57dST8+dZVFcmVTB546aFEqGOk5KQFFl4BCzxqj2TNYuuwK4vkLxM5JbpxDN6Q== X-Received: by 2002:a05:6a00:2995:b0:525:398b:8585 with SMTP id cj21-20020a056a00299500b00525398b8585mr9186399pfb.7.1655929661568; Wed, 22 Jun 2022 13:27:41 -0700 (PDT) Received: from hermes.local (204-195-112-199.wavecable.com. [204.195.112.199]) by smtp.gmail.com with ESMTPSA id p11-20020a170903248b00b00161ac982b52sm13244438plw.95.2022.06.22.13.27.40 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 22 Jun 2022 13:27:41 -0700 (PDT) From: Stephen Hemminger <stephen@networkplumber.org> To: dev@dpdk.org Cc: Stephen Hemminger <stephen@networkplumber.org> Subject: [PATCH 0/2] remove unnecessary words in function documention Date: Wed, 22 Jun 2022 13:27:36 -0700 Message-Id: <20220622202738.401690-1-stephen@networkplumber.org> X-Mailer: git-send-email 2.35.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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 |
| Series |
remove unnecessary words in function documention
|
|
Message
Stephen Hemminger
June 22, 2022, 8:27 p.m. UTC
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(-)
Comments
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@linux.microsoft.com>
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
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.
On Wed, Jun 22, 2022 at 10:27 PM Stephen Hemminger <stephen@networkplumber.org> 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(-) Applied, thanks.