From patchwork Tue Aug 10 14:34:20 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ray Kinsella X-Patchwork-Id: 96785 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: 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 A42A0A0C47; Tue, 10 Aug 2021 16:36:41 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 333C340686; Tue, 10 Aug 2021 16:36:41 +0200 (CEST) Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by mails.dpdk.org (Postfix) with ESMTP id 4F7E34014F for ; Tue, 10 Aug 2021 16:36:39 +0200 (CEST) X-IronPort-AV: E=McAfee;i="6200,9189,10070"; a="214941248" X-IronPort-AV: E=Sophos;i="5.84,310,1620716400"; d="scan'208";a="214941248" Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga103.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 10 Aug 2021 07:36:37 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.84,310,1620716400"; d="scan'208";a="671786693" Received: from silpixa00396680.ir.intel.com (HELO silpixa00396680.ger.corp.intel.com) ([10.237.223.54]) by fmsmga006.fm.intel.com with ESMTP; 10 Aug 2021 07:36:35 -0700 From: Ray Kinsella To: dev@dpdk.org Cc: bruce.richardson@intel.com, john.mcnamara@intel.com, aaron.conole@redhat.com, mdr@ashroe.eu Date: Tue, 10 Aug 2021 15:34:20 +0100 Message-Id: <20210810143420.990875-1-mdr@ashroe.eu> X-Mailer: git-send-email 2.26.2 In-Reply-To: <20210809130601.930651-1-mdr@ashroe.eu> References: <20210809130601.930651-1-mdr@ashroe.eu> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH v2] doc: fix CI typo warnings X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Fix documentation typos that are generating spurious CI warnings. Signed-off-by: Ray Kinsella Acked-by: Aaron Conole Reviewed-by: Conor Walsh Acked-by: Aaron Conole Reviewed-by: Conor Walsh --- v2: * Fix some additional typos pointed out by Aaron Conole doc/guides/rel_notes/deprecation.rst | 4 ++-- doc/guides/sample_app_ug/ioat.rst | 2 +- doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +- examples/ioat/ioatfwd.c | 2 +- examples/vmdq/main.c | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 76a4abfd6b..65023e39d8 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -208,7 +208,7 @@ Deprecation Notices * cryptodev: The structure ``rte_crypto_sym_vec`` would be updated to add ``dest_sgl`` to support out of place processing. - This field will be null for inplace processing. + This field will be null for in place processing. This change is targeted for DPDK 21.11. * cryptodev: The structure ``rte_crypto_vec`` would be updated to add @@ -233,7 +233,7 @@ Deprecation Notices * security: The IPsec configuration structure ``struct rte_security_ipsec_xform`` will be updated with new members to allow SA lifetime configuration. A new structure would be introduced to replace the - current member, ``esn_soft_limit``. + current member ``esn_soft_limit``. * security: The structure ``rte_security_ipsec_xform`` will be extended with multiple fields: source and destination port of UDP encapsulation, diff --git a/doc/guides/sample_app_ug/ioat.rst b/doc/guides/sample_app_ug/ioat.rst index ee0a627b06..b364be3b5d 100644 --- a/doc/guides/sample_app_ug/ioat.rst +++ b/doc/guides/sample_app_ug/ioat.rst @@ -236,7 +236,7 @@ function in order to start processing for each lcore: .. literalinclude:: ../../../examples/ioat/ioatfwd.c :language: c :start-after: Start processing for each lcore. 8< - :end-before: >8 End of starting to processfor each lcore. + :end-before: >8 End of starting to process for each lcore. :dedent: 0 The function launches Rx/Tx processing functions on configured lcores diff --git a/doc/guides/sample_app_ug/vmdq_forwarding.rst b/doc/guides/sample_app_ug/vmdq_forwarding.rst index ae1b5660df..ed28525a15 100644 --- a/doc/guides/sample_app_ug/vmdq_forwarding.rst +++ b/doc/guides/sample_app_ug/vmdq_forwarding.rst @@ -103,7 +103,7 @@ the MAC of VMDq pool 2 on port 1 is 52:54:00:12:01:02. .. literalinclude:: ../../../examples/vmdq/main.c :language: c - :start-after: Building correct configruration for vdmq. 8< + :start-after: Building correct configuration for vdmq. 8< :end-before: >8 End of get_eth_conf. Once the network port has been initialized using the correct VMDq values, diff --git a/examples/ioat/ioatfwd.c b/examples/ioat/ioatfwd.c index 0c413180f8..c57a8b82f0 100644 --- a/examples/ioat/ioatfwd.c +++ b/examples/ioat/ioatfwd.c @@ -564,7 +564,7 @@ static void start_forwarding_cores(void) lcore_id); } } -/* >8 End of starting to processfor each lcore. */ +/* >8 End of starting to process for each lcore. */ /* Display usage */ static void diff --git a/examples/vmdq/main.c b/examples/vmdq/main.c index d3bc19f78e..843cf0bf1e 100644 --- a/examples/vmdq/main.c +++ b/examples/vmdq/main.c @@ -136,7 +136,7 @@ static struct rte_ether_addr vmdq_ports_eth_addr[RTE_MAX_ETHPORTS]; * valid pool number */ - /* Building correct configruration for vdmq. 8< */ + /* Building correct configuration for vdmq. 8< */ static inline int get_eth_conf(struct rte_eth_conf *eth_conf, uint32_t num_pools) {